Official websites use .gov
A
.gov website belongs to an official government
organization in the United States.
Secure .gov websites use HTTPS
A
lock (
) or https:// means you’ve safely connected to
the .gov website. Share sensitive information only on official,
secure websites.
::: content
[;{.source}]{.comments} {.source}[; NOSA HEADER START{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; The contents of this file are subject to the terms of the NASA Open {.source}]{.comments} {.source}[; Source Agreement (NOSA), Version 1.3 only (the "Agreement"). You may {.source}]{.comments} {.source}[; not use this file except in compliance with the Agreement.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; You can obtain a copy of the agreement at{.source}]{.comments} {.source}[; docs/NASA_Open_Source_Agreement_1.3.txt{.source}]{.comments} {.source}[; or {.source}]{.comments} {.source}[; http://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; See the Agreement for the specific language governing permissions{.source}]{.comments} {.source}[; and limitations under the Agreement.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; When distributing Covered Code, include this NOSA HEADER in each{.source}]{.comments} {.source}[; file and include the Agreement file at {.source}]{.comments} {.source}[; docs/NASA_Open_Source_Agreement_1.3.txt. If applicable, add the {.source}]{.comments} {.source}[; following below this NOSA HEADER, with the fields enclosed by {.source}]{.comments} {.source}[; brackets "[]" replaced with your own identifying information: {.source}]{.comments} {.source}[; Portions Copyright [yyyy] [name of copyright owner]{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; NOSA HEADER END{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; Copyright (c) 2013 United States Government as represented by the {.source}]{.comments} {.source}[; National Aeronautics and Space Administration. No copyright is claimed {.source}]{.comments} {.source}[; in the United States under Title 17, U.S.Code. All Other Rights Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; This class is an IDL representation of the SatelliteData{.source}]{.comments} {.source}[; element from the{.source}]{.comments} {.source}[; <a href="http://sscweb.gsfc.nasa.gov/">Satellite Situation Center</a>{.source}]{.comments} {.source}[; (SSC) XML schema.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @copyright Copyright (c) 2013 United States Government as represented{.source}]{.comments} {.source}[; by the National Aeronautics and Space Administration. No{.source}]{.comments} {.source}[; copyright is claimed in the United States under Title 17,{.source}]{.comments} {.source}[; U.S.Code. All Other Rights Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @author B. Harris{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; Creates an SpdfSatelliteData object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param id {in} {type=string}{.source}]{.comments} {.source}[; satellite identifier.{.source}]{.comments} {.source}[; @param coordinateData {in} {type=SpdfCoordinateData}{.source}]{.comments} {.source}[; satellite coordinate data.{.source}]{.comments} {.source}[; @param time {in} {type=dblarr}{.source}]{.comments} {.source}[; julday time associated with each data point.{.source}]{.comments} {.source}[; @keyword bTraceData {in} {optional} {type=SpdfBTraceData}{.source}]{.comments} {.source}[; magnetic field trace data.{.source}]{.comments} {.source}[; @keyword radialLength {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; distance from center of Earth.{.source}]{.comments} {.source}[; @keyword magneticStrength {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; magnetic field strength.{.source}]{.comments} {.source}[; @keyword neutralSheetDistance {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; distance from neutral sheet.{.source}]{.comments} {.source}[; @keyword bowShockDistance {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; distance from bow shock.{.source}]{.comments} {.source}[; @keyword magnetoPauseDistance {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; distance from magneto pause.{.source}]{.comments} {.source}[; @keyword dipoleLValue {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; dipole L values.{.source}]{.comments} {.source}[; @keyword dipoleInvariantLatitude {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; dipole invariant latitude values.{.source}]{.comments} {.source}[; @keyword spacecraftRegion {in} {optional} {type=strarr}{.source}]{.comments} {.source}[; spacecraft region.{.source}]{.comments} {.source}[; @keyword radialTracedFootpointRegions {in} {optional} {type=strarr}{.source}]{.comments} {.source}[; radial traced footpoint region.{.source}]{.comments} {.source}[; @keyword bGseX {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; B GSE X values.{.source}]{.comments} {.source}[; @keyword bGseY {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; B GSE Y values.{.source}]{.comments} {.source}[; @keyword bGseZ {in} {optional} {type=dblarr}{.source}]{.comments} {.source}[; B GSE Z values.{.source}]{.comments} {.source}[; @keyword northBTracedFootpointRegions {in} {optional} {type=strarr}{.source}]{.comments} {.source}[; north B traced regions.{.source}]{.comments} {.source}[; @keyword southBTracedFootpointRegions {in} {optional} {type=strarr}{.source}]{.comments} {.source}[; south B traced regions.{.source}]{.comments} {.source}[; @returns reference to an SpdfSatelliteData object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::init:source}function SpdfSatelliteData::init, $ id, $ coordinateData, $ time, $ bTraceData = bTraceData, $ radialLength = radialLength, $ magneticStrength = magneticStrength, $ neutralSheetDistance = neutralSheetDistance, $ bowShockDistance = bowShockDistance, $ magnetoPauseDistance = magnetoPauseDistance, $ dipoleLValue = dipoleLValue, $ dipoleInvariantLatitude = dipoleInvariantLatitude, $ spacecraftRegion = spacecraftRegion, $ radialTracedFootpointRegions = radialTracedFootpointRegions, $ bGseX = bGseX, $ bGseY = bGseY, $ bGseZ = bGseZ, $ northBTracedFootpointRegions = northBTracedFootpointRegions, $ southBTracedFootpointRegions = southBTracedFootpointRegions compile_opt idl2 self.id = id self.coordinateData = ptr_new(coordinateData) self.time = ptr_new(time) if keyword_set(bTraceData) then $ self.bTraceData = ptr_new(bTraceData) if keyword_set(radialLength) then $ self.radialLength = ptr_new(radialLength) if keyword_set(magneticStrength) then $ self.magneticStrength = ptr_new(magneticStrength) if keyword_set(neutralSheetDistance) then $ self.neutralSheetDistance = ptr_new(neutralSheetDistance) if keyword_set(bowShockDistance) then $ self.bowShockDistance = ptr_new(bowShockDistance) if keyword_set(magnetoPauseDistance) then $ self.magnetoPauseDistance = ptr_new(magnetoPauseDistance) if keyword_set(dipoleLValue) then $ self.dipoleLValue = ptr_new(dipoleLValue) if keyword_set(dipoleInvariantLatitude) then $ self.dipoleInvariantLatitude = ptr_new(dipoleInvariantLatitude) if keyword_set(spacecraftRegion) then $ self.spacecraftRegion = ptr_new(spacecraftRegion) if keyword_set(radialTracedFootpointRegions) then begin self.radialTracedFootpointRegions = $ ptr_new(radialTracedFootpointRegions) endif if keyword_set(bGseX) then self.bGseX = ptr_new(bGseX) if keyword_set(bGseY) then self.bGseY = ptr_new(bGseY) if keyword_set(bGseZ) then self.bGseZ = ptr_new(bGseZ) if keyword_set(northBTracedFootpointRegions) then $ self.northBTracedFootpointRegions = ptr_new(northBTracedFootpointRegions) if keyword_set(southBTracedFootpointRegions) then $ self.southBTracedFootpointRegions = ptr_new(southBTracedFootpointRegions) return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::cleanup:source}pro SpdfSatelliteData::cleanup compile_opt idl2 if ptr_valid(self.coordinateData) then $ ptr_free, self.coordinateData if ptr_valid(self.time) then ptr_free, self.time if ptr_valid(self.bTraceData) then $ ptr_free, self.bTraceData if ptr_valid(self.radialLength) then $ ptr_free, self.radialLength if ptr_valid(self.magneticStrength) then $ ptr_free, self.magneticStrength if ptr_valid(self.neutralSheetDistance) then $ ptr_free, self.neutralSheetDistance if ptr_valid(self.bowShockDistance) then $ ptr_free, self.bowShockDistance if ptr_valid(self.magnetoPauseDistance) then $ ptr_free, self.magnetoPauseDistance if ptr_valid(self.dipoleLValue) then $ ptr_free, self.dipoleLValue if ptr_valid(self.dipoleInvariantLatitude) then $ ptr_free, self.dipoleInvariantLatitude if ptr_valid(self.spacecraftRegion) then $ ptr_free, self.spacecraftRegion if ptr_valid(self.radialTracedFootpointRegions) then $ ptr_free, self.radialTracedFootpointRegions if ptr_valid(self.bGseX) then ptr_free, self.bGseX if ptr_valid(self.bGseY) then ptr_free, self.bGseY if ptr_valid(self.bGseZ) then ptr_free, self.bGseZ if ptr_valid(self.northBTracedFootpointRegions) then $ ptr_free, self.northBTracedFootpointRegions if ptr_valid(self.southBTracedFootpointRegions) then $ ptr_free, self.southBTracedFootpointRegions end {.source}[;+{.source}]{.comments} {.source}[; Gets the id value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns id value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getId:source}function SpdfSatelliteData::getId compile_opt idl2 return, self.id end {.source}[;+{.source}]{.comments} {.source}[; Gets the coordinate data.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a reference to coordinate data.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getCoordinateData:source}function SpdfSatelliteData::getCoordinateData compile_opt idl2 if ptr_valid(self.coordinateData) then begin return, *self.coordinateData endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the time values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns the time values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getTime:source}function SpdfSatelliteData::getTime compile_opt idl2 if ptr_valid(self.time) then begin return, *self.time endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the B field trace data.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a reference to SpdfBTraceData.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getBTraceData:source}function SpdfSatelliteData::getBTraceData compile_opt idl2 if ptr_valid(self.bTraceData) then begin return, *self.bTraceData endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the radial length values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing radial length values or the{.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getRadialLength:source}function SpdfSatelliteData::getRadialLength compile_opt idl2 if ptr_valid(self.radialLength) then begin return, *self.radialLength endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the magnetic strength values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing magnetic strength values or the {.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getMagneticStrength:source}function SpdfSatelliteData::getMagneticStrength compile_opt idl2 if ptr_valid(self.magneticStrength) then begin return, *self.magneticStrength endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the neutral sheet distance values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing neutral sheet distance values or the{.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getNeutralSheetDistance:source}function SpdfSatelliteData::getNeutralSheetDistance compile_opt idl2 if ptr_valid(self.neutralSheetDistance) then begin return, *self.neutralSheetDistance endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the bow shock distance values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing bow shock distance values or the{.source}]{.comments} {.source}[; constant scaler !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getBowShockDistance:source}function SpdfSatelliteData::getBowShockDistance compile_opt idl2 if ptr_valid(self.bowShockDistance) then begin return, *self.bowShockDistance endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the magneto pause distance values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing magneto pause distance values or the{.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getMagnetoPauseDistance:source}function SpdfSatelliteData::getMagnetoPauseDistance compile_opt idl2 if ptr_valid(self.magnetoPauseDistance) then begin return, *self.magnetoPauseDistance endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the dipole L values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing dipole L values or the{.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getDipoleLValue:source}function SpdfSatelliteData::getDipoleLValue compile_opt idl2 if ptr_valid(self.dipoleLValue) then begin return, *self.dipoleLValue endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the dipole invariant latitude values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing dipole invariant latitude values or the{.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getDipoleInvariantLatitude:source}function SpdfSatelliteData::getDipoleInvariantLatitude compile_opt idl2 if ptr_valid(self.dipoleInvariantLatitude) then begin return, *self.dipoleInvariantLatitude endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the spacecraft region values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a strarr containing spacecraft region values or the{.source}]{.comments} {.source}[; constant scalar '' if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getSpacecraftRegion:source}function SpdfSatelliteData::getSpacecraftRegion compile_opt idl2 if ptr_valid(self.spacecraftRegion) then begin return, *self.spacecraftRegion endif else begin return, '' endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the radial trace footpoint region values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a strarr containing radial trace footpoint region values or{.source}]{.comments} {.source}[; the constant scalar '' if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getRadialTracedFootpointRegions:source}function SpdfSatelliteData::getRadialTracedFootpointRegions compile_opt idl2 if ptr_valid(self.radialTracedFootpointRegions) then begin return, *self.radialTracedFootpointRegions endif else begin return, '' endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the B GSE X values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing B GSE X values or the{.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getBGseX:source}function SpdfSatelliteData::getBGseX compile_opt idl2 if ptr_valid(self.bGseX) then begin return, *self.bGseX endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the B GSE Y values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing B GSE Y values or the{.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getBGseY:source}function SpdfSatelliteData::getBGseY compile_opt idl2 if ptr_valid(self.bGseY) then begin return, *self.bGseY endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the B GSE Z values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing B GSE Z values or the{.source}]{.comments} {.source}[; constant scalar !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getBGseZ:source}function SpdfSatelliteData::getBGseZ compile_opt idl2 if ptr_valid(self.bGseZ) then begin return, *self.bGseZ endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the north B traced regions values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a strarr containing north B traced regions values or the{.source}]{.comments} {.source}[; constant scalar '' if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getNorthBTracedFootpointRegions:source}function SpdfSatelliteData::getNorthBTracedFootpointRegions compile_opt idl2 if ptr_valid(self.northBTracedFootpointRegions) then begin return, *self.northBTracedFootpointRegions endif else begin return, '' endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the south B traced regions values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a strarr containing south B traced regions values or the{.source}]{.comments} {.source}[; constant scalar '' if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData::getSouthBTracedFootpointRegions:source}function SpdfSatelliteData::getSouthBTracedFootpointRegions compile_opt idl2 if ptr_valid(self.southBTracedFootpointRegions) then begin return, *self.southBTracedFootpointRegions endif else begin return, '' endelse end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfSatelliteData class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field id satellite identifier.{.source}]{.comments} {.source}[; @field coordinateData satellite coordinate data.{.source}]{.comments} {.source}[; @field time time associated with each data point.{.source}]{.comments} {.source}[; @field bTraceData magnetic field trace data.{.source}]{.comments} {.source}[; @field radialLength distance from center of Earth.{.source}]{.comments} {.source}[; @field magneticStrength magnetic field strength.{.source}]{.comments} {.source}[; @field neutralSheetDistance distance from neutral sheet.{.source}]{.comments} {.source}[; @field bowShockDistance distance from bow shock.{.source}]{.comments} {.source}[; @field magnetoPauseDistance distance from magneto pause.{.source}]{.comments} {.source}[; @field dipoleLValue dipole L values.{.source}]{.comments} {.source}[; @field dipoleInvariantLatitude dipole invariant latitude values.{.source}]{.comments} {.source}[; @field spacecraftRegion spacecraft region.{.source}]{.comments} {.source}[; @field radialTracedFootpointRegions radial trace footpoint region.{.source}]{.comments} {.source}[; @field bGseX B GSE X values.{.source}]{.comments} {.source}[; @field bGseY B GSE Y values.{.source}]{.comments} {.source}[; @field bGseZ B GSE Z values.{.source}]{.comments} {.source}[; @field northBTracedFootpointRegions north B traced regions.{.source}]{.comments} {.source}[; @field southBTracedFootpointRegions south B traced regions.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfSatelliteData__define:source}pro SpdfSatelliteData__define compile_opt idl2 struct = { SpdfSatelliteData, $ id:'', $ coordinateData:ptr_new(), $ time:ptr_new(), $ bTraceData:ptr_new(), $ radialLength:ptr_new(), $ magneticStrength:ptr_new(), $ neutralSheetDistance:ptr_new(), $ bowShockDistance:ptr_new(), $ magnetoPauseDistance:ptr_new(), $ dipoleLValue:ptr_new(), $ dipoleInvariantLatitude:ptr_new(), $ spacecraftRegion:ptr_new(), $ radialTracedFootpointRegions:ptr_new(), $ bGseX:ptr_new(), $ bGseY:ptr_new(), $ bGseZ:ptr_new(), $ northBTracedFootpointRegions:ptr_new(), $ southBTracedFootpointRegions:ptr_new() $ } end {.source}
:::
