![[attach.png]](idldoc-resources/attach.png)
./
spdfsatellitedata__define.pro
This class is an IDL representation of the SatelliteData element from the Satellite Situation Center (SSC) XML schema.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2013 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.
Class description for SpdfSatelliteData
Properties
Properties in SpdfSatelliteData
- bGseX init
- bGseY init
- bGseZ init
- bTraceData init
- bowShockDistance init
- dipoleInvariantLatitude init
- dipoleLValue init
- magneticStrength init
- magnetoPauseDistance init
- neutralSheetDistance init
- northBTracedFootpointRegions init
- radialLength init
- radialTracedFootpointRegions init
- southBTracedFootpointRegions init
- spacecraftRegion init
Routines
Routines from spdfsatellitedata__define.pro
result = SpdfSatelliteData::init(id, coordinateData, time [, bTraceData=SpdfBTraceData] [, radialLength=dblarr] [, magneticStrength=dblarr] [, neutralSheetDistance=dblarr] [, bowShockDistance=dblarr] [, magnetoPauseDistance=dblarr] [, dipoleLValue=dblarr] [, dipoleInvariantLatitude=dblarr] [, spacecraftRegion=strarr] [, radialTracedFootpointRegions=strarr] [, bGseX=dblarr] [, bGseY=dblarr] [, bGseZ=dblarr] [, northBTracedFootpointRegions=strarr] [, southBTracedFootpointRegions=strarr])Creates an SpdfSatelliteData object.
SpdfSatelliteData::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfSatelliteData::getId()Gets the id value.
result = SpdfSatelliteData::getCoordinateData()Gets the coordinate data.
result = SpdfSatelliteData::getTime()Gets the time values.
result = SpdfSatelliteData::getBTraceData()Gets the B field trace data.
result = SpdfSatelliteData::getRadialLength()Gets the radial length values.
result = SpdfSatelliteData::getMagneticStrength()Gets the magnetic strength values.
result = SpdfSatelliteData::getNeutralSheetDistance()Gets the neutral sheet distance values.
result = SpdfSatelliteData::getBowShockDistance()Gets the bow shock distance values.
result = SpdfSatelliteData::getMagnetoPauseDistance()Gets the magneto pause distance values.
result = SpdfSatelliteData::getDipoleLValue()Gets the dipole L values.
result = SpdfSatelliteData::getDipoleInvariantLatitude()Gets the dipole invariant latitude values.
result = SpdfSatelliteData::getSpacecraftRegion()Gets the spacecraft region values.
result = SpdfSatelliteData::getRadialTracedFootpointRegions()Gets the radial trace footpoint region values.
result = SpdfSatelliteData::getBGseX()Gets the B GSE X values.
result = SpdfSatelliteData::getBGseY()Gets the B GSE Y values.
result = SpdfSatelliteData::getBGseZ()Gets the B GSE Z values.
result = SpdfSatelliteData::getNorthBTracedFootpointRegions()Gets the north B traced regions values.
result = SpdfSatelliteData::getSouthBTracedFootpointRegions()Gets the south B traced regions values.
SpdfSatelliteData__defineDefines the SpdfSatelliteData class.
Routine details
top source SpdfSatelliteData::init
result = SpdfSatelliteData::init(id, coordinateData, time [, bTraceData=SpdfBTraceData] [, radialLength=dblarr] [, magneticStrength=dblarr] [, neutralSheetDistance=dblarr] [, bowShockDistance=dblarr] [, magnetoPauseDistance=dblarr] [, dipoleLValue=dblarr] [, dipoleInvariantLatitude=dblarr] [, spacecraftRegion=strarr] [, radialTracedFootpointRegions=strarr] [, bGseX=dblarr] [, bGseY=dblarr] [, bGseZ=dblarr] [, northBTracedFootpointRegions=strarr] [, southBTracedFootpointRegions=strarr])
Creates an SpdfSatelliteData object.
Return value
reference to an SpdfSatelliteData object.
Parameters
- id in type=string
satellite identifier.
- coordinateData in type=SpdfCoordinateData
satellite coordinate data.
- time in type=dblarr
julday time associated with each data point.
Keywords
- bTraceData in optional type=SpdfBTraceData
magnetic field trace data.
- radialLength in optional type=dblarr
distance from center of Earth.
- magneticStrength in optional type=dblarr
magnetic field strength.
- neutralSheetDistance in optional type=dblarr
distance from neutral sheet.
- bowShockDistance in optional type=dblarr
distance from bow shock.
- magnetoPauseDistance in optional type=dblarr
distance from magneto pause.
- dipoleLValue in optional type=dblarr
dipole L values.
- dipoleInvariantLatitude in optional type=dblarr
dipole invariant latitude values.
- spacecraftRegion in optional type=strarr
spacecraft region.
- radialTracedFootpointRegions in optional type=strarr
radial traced footpoint region.
- bGseX in optional type=dblarr
B GSE X values.
- bGseY in optional type=dblarr
B GSE Y values.
- bGseZ in optional type=dblarr
B GSE Z values.
- northBTracedFootpointRegions in optional type=strarr
north B traced regions.
- southBTracedFootpointRegions in optional type=strarr
south B traced regions.
top source SpdfSatelliteData::cleanup
SpdfSatelliteData::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfSatelliteData::getId
result = SpdfSatelliteData::getId()
Gets the id value.
Return value
id value.
top source SpdfSatelliteData::getCoordinateData
result = SpdfSatelliteData::getCoordinateData()
Gets the coordinate data.
Return value
a reference to coordinate data.
top source SpdfSatelliteData::getTime
result = SpdfSatelliteData::getTime()
Gets the time values.
Return value
the time values.
top source SpdfSatelliteData::getBTraceData
result = SpdfSatelliteData::getBTraceData()
Gets the B field trace data.
Return value
a reference to SpdfBTraceData.
top source SpdfSatelliteData::getRadialLength
result = SpdfSatelliteData::getRadialLength()
Gets the radial length values.
Return value
a dblarr containing radial length values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getMagneticStrength
result = SpdfSatelliteData::getMagneticStrength()
Gets the magnetic strength values.
Return value
a dblarr containing magnetic strength values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getNeutralSheetDistance
result = SpdfSatelliteData::getNeutralSheetDistance()
Gets the neutral sheet distance values.
Return value
a dblarr containing neutral sheet distance values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getBowShockDistance
result = SpdfSatelliteData::getBowShockDistance()
Gets the bow shock distance values.
Return value
a dblarr containing bow shock distance values or the constant scaler !values.d_NaN if there are no values.
top source SpdfSatelliteData::getMagnetoPauseDistance
result = SpdfSatelliteData::getMagnetoPauseDistance()
Gets the magneto pause distance values.
Return value
a dblarr containing magneto pause distance values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getDipoleLValue
result = SpdfSatelliteData::getDipoleLValue()
Gets the dipole L values.
Return value
a dblarr containing dipole L values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getDipoleInvariantLatitude
result = SpdfSatelliteData::getDipoleInvariantLatitude()
Gets the dipole invariant latitude values.
Return value
a dblarr containing dipole invariant latitude values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getSpacecraftRegion
result = SpdfSatelliteData::getSpacecraftRegion()
Gets the spacecraft region values.
Return value
a strarr containing spacecraft region values or the constant scalar '' if there are no values.
top source SpdfSatelliteData::getRadialTracedFootpointRegions
result = SpdfSatelliteData::getRadialTracedFootpointRegions()
Gets the radial trace footpoint region values.
Return value
a strarr containing radial trace footpoint region values or the constant scalar '' if there are no values.
top source SpdfSatelliteData::getBGseX
result = SpdfSatelliteData::getBGseX()
Gets the B GSE X values.
Return value
a dblarr containing B GSE X values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getBGseY
result = SpdfSatelliteData::getBGseY()
Gets the B GSE Y values.
Return value
a dblarr containing B GSE Y values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getBGseZ
result = SpdfSatelliteData::getBGseZ()
Gets the B GSE Z values.
Return value
a dblarr containing B GSE Z values or the constant scalar !values.d_NaN if there are no values.
top source SpdfSatelliteData::getNorthBTracedFootpointRegions
result = SpdfSatelliteData::getNorthBTracedFootpointRegions()
Gets the north B traced regions values.
Return value
a strarr containing north B traced regions values or the constant scalar '' if there are no values.
File attributes
| Modification date: | Fri May 13 08:54:13 2022 |
| Lines: | 250 |
SSC Feedback.