::: header

SSC R2.4 Web Services API

Generated by IDLdoc

:::

Overview Directory File Source [attach.png] {align=“top”} Etc Categories Search Index Help User documentation

single page{target=“_top”} | use frames{target=“_top”} summary class fields routine details file attributes

::: content

./

spdfsatellitedata__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class is an IDL representation of the SatelliteData element from the Satellite Situation Center (SSC) XML schema. ::: :::

Author information

Author

: B. Harris

: 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

Class description for SpdfSatelliteData

Properties

Properties in SpdfSatelliteData

::: details

bGseX [init ]{.smaller}

bGseY [init ]{.smaller}

bGseZ [init ]{.smaller}

bTraceData [init ]{.smaller}

bowShockDistance [init ]{.smaller}

dipoleInvariantLatitude [init ]{.smaller}

dipoleLValue [init ]{.smaller}

magneticStrength [init ]{.smaller}

magnetoPauseDistance [init ]{.smaller}

neutralSheetDistance [init ]{.smaller}

northBTracedFootpointRegions [init ]{.smaller}

radialLength [init ]{.smaller}

radialTracedFootpointRegions [init ]{.smaller}

southBTracedFootpointRegions [init ]{.smaller}

spacecraftRegion [init ]{.smaller}

:
::: :::

Routines

Routines from spdfsatellitedata__define.pro

: Creates an SpdfSatelliteData object.

SpdfSatelliteData::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfSatelliteData::getId()

: Gets the id value.

[result]{.var} = SpdfSatelliteData::getCoordinateData()

: Gets the coordinate data.

[result]{.var} = SpdfSatelliteData::getTime()

: Gets the time values.

[result]{.var} = SpdfSatelliteData::getBTraceData()

: Gets the B field trace data.

[result]{.var} = SpdfSatelliteData::getRadialLength()

: Gets the radial length values.

[result]{.var} = SpdfSatelliteData::getMagneticStrength()

: Gets the magnetic strength values.

[result]{.var} = SpdfSatelliteData::getNeutralSheetDistance()

: Gets the neutral sheet distance values.

[result]{.var} = SpdfSatelliteData::getBowShockDistance()

: Gets the bow shock distance values.

[result]{.var} = SpdfSatelliteData::getMagnetoPauseDistance()

: Gets the magneto pause distance values.

[result]{.var} = SpdfSatelliteData::getDipoleLValue()

: Gets the dipole L values.

[result]{.var} = SpdfSatelliteData::getDipoleInvariantLatitude()

: Gets the dipole invariant latitude values.

[result]{.var} = SpdfSatelliteData::getSpacecraftRegion()

: Gets the spacecraft region values.

[result]{.var} = SpdfSatelliteData::getRadialTracedFootpointRegions()

: Gets the radial trace footpoint region values.

[result]{.var} = SpdfSatelliteData::getBGseX()

: Gets the B GSE X values.

[result]{.var} = SpdfSatelliteData::getBGseY()

: Gets the B GSE Y values.

[result]{.var} = SpdfSatelliteData::getBGseZ()

: Gets the B GSE Z values.

[result]{.var} = SpdfSatelliteData::getNorthBTracedFootpointRegions()

: Gets the north B traced regions values.

[result]{.var} = SpdfSatelliteData::getSouthBTracedFootpointRegions()

: Gets the south B traced regions values.

SpdfSatelliteData__define

: Defines the SpdfSatelliteData class.

::: {#routine-details}

Routine details

::: {#SpdfSatelliteData::init .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::init[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::init([id]{.argument}[, coordinateData]{.argument}[, time]{.argument}[[,bTraceData=[SpdfBTraceData]{.var}]]{.argument}[[,radialLength=[dblarr]{.var}]]{.argument}[[,magneticStrength=[dblarr]{.var}]]{.argument}[[,neutralSheetDistance=[dblarr]{.var}]]{.argument}[[,bowShockDistance=[dblarr]{.var}]]{.argument}[[,magnetoPauseDistance=[dblarr]{.var}]]{.argument}[[,dipoleLValue=[dblarr]{.var}]]{.argument}[[,dipoleInvariantLatitude=[dblarr]{.var}]]{.argument}[[,spacecraftRegion=[strarr]{.var}]]{.argument}[[,radialTracedFootpointRegions=[strarr]{.var}]]{.argument}[[,bGseX=[dblarr]{.var}]]{.argument}[[,bGseY=[dblarr]{.var}]]{.argument}[[,bGseZ=[dblarr]{.var}]]{.argument}[[,northBTracedFootpointRegions=[strarr]{.var}]]{.argument}[[,southBTracedFootpointRegions=[strarr]{.var}]]{.argument})

Creates an SpdfSatelliteData object.

Return value

::: small reference to an SpdfSatelliteData object. :::

Parameters

id [in type=string ]{.smaller}

: satellite identifier.

coordinateData [in type=SpdfCoordinateData ]{.smaller}

: satellite coordinate data.

time [in type=dblarr ]{.smaller}

: julday time associated with each data point.

Keywords

bTraceData [in optional type=SpdfBTraceData ]{.smaller}

: magnetic field trace data.

radialLength [in optional type=dblarr ]{.smaller}

: distance from center of Earth.

magneticStrength [in optional type=dblarr ]{.smaller}

: magnetic field strength.

neutralSheetDistance [in optional type=dblarr ]{.smaller}

: distance from neutral sheet.

bowShockDistance [in optional type=dblarr ]{.smaller}

: distance from bow shock.

magnetoPauseDistance [in optional type=dblarr ]{.smaller}

: distance from magneto pause.

dipoleLValue [in optional type=dblarr ]{.smaller}

: dipole L values.

dipoleInvariantLatitude [in optional type=dblarr ]{.smaller}

: dipole invariant latitude values.

spacecraftRegion [in optional type=strarr ]{.smaller}

: spacecraft region.

radialTracedFootpointRegions [in optional type=strarr ]{.smaller}

: radial traced footpoint region.

bGseX [in optional type=dblarr ]{.smaller}

: B GSE X values.

bGseY [in optional type=dblarr ]{.smaller}

: B GSE Y values.

bGseZ [in optional type=dblarr ]{.smaller}

: B GSE Z values.

northBTracedFootpointRegions [in optional type=strarr ]{.smaller}

: north B traced regions.

southBTracedFootpointRegions [in optional type=strarr ]{.smaller}

: south B traced regions. :::

::: {#SpdfSatelliteData::cleanup .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::cleanup[]{.routine-attributes}

SpdfSatelliteData::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfSatelliteData::getId .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getId[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getId()

Gets the id value.

Return value

::: small id value. ::: :::

::: {#SpdfSatelliteData::getCoordinateData .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getCoordinateData[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getCoordinateData()

Gets the coordinate data.

Return value

::: small a reference to coordinate data. ::: :::

::: {#SpdfSatelliteData::getTime .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getTime[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getTime()

Gets the time values.

Return value

::: small the time values. ::: :::

::: {#SpdfSatelliteData::getBTraceData .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getBTraceData[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getBTraceData()

Gets the B field trace data.

Return value

::: small a reference to SpdfBTraceData. ::: :::

::: {#SpdfSatelliteData::getRadialLength .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getRadialLength[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getRadialLength()

Gets the radial length values.

Return value

::: small a dblarr containing radial length values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getMagneticStrength .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getMagneticStrength[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getMagneticStrength()

Gets the magnetic strength values.

Return value

::: small a dblarr containing magnetic strength values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getNeutralSheetDistance .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getNeutralSheetDistance[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getNeutralSheetDistance()

Gets the neutral sheet distance values.

Return value

::: small a dblarr containing neutral sheet distance values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getBowShockDistance .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getBowShockDistance[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getBowShockDistance()

Gets the bow shock distance values.

Return value

::: small a dblarr containing bow shock distance values or the constant scaler !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getMagnetoPauseDistance .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getMagnetoPauseDistance[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getMagnetoPauseDistance()

Gets the magneto pause distance values.

Return value

::: small a dblarr containing magneto pause distance values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getDipoleLValue .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getDipoleLValue[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getDipoleLValue()

Gets the dipole L values.

Return value

::: small a dblarr containing dipole L values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getDipoleInvariantLatitude .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getDipoleInvariantLatitude[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getDipoleInvariantLatitude()

Gets the dipole invariant latitude values.

Return value

::: small a dblarr containing dipole invariant latitude values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getSpacecraftRegion .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getSpacecraftRegion[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getSpacecraftRegion()

Gets the spacecraft region values.

Return value

::: small a strarr containing spacecraft region values or the constant scalar ” if there are no values. ::: :::

::: {#SpdfSatelliteData::getRadialTracedFootpointRegions .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getRadialTracedFootpointRegions[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getRadialTracedFootpointRegions()

Gets the radial trace footpoint region values.

Return value

::: small a strarr containing radial trace footpoint region values or the constant scalar ” if there are no values. ::: :::

::: {#SpdfSatelliteData::getBGseX .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getBGseX[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getBGseX()

Gets the B GSE X values.

Return value

::: small a dblarr containing B GSE X values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getBGseY .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getBGseY[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getBGseY()

Gets the B GSE Y values.

Return value

::: small a dblarr containing B GSE Y values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getBGseZ .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getBGseZ[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getBGseZ()

Gets the B GSE Z values.

Return value

::: small a dblarr containing B GSE Z values or the constant scalar !values.d_NaN if there are no values. ::: :::

::: {#SpdfSatelliteData::getNorthBTracedFootpointRegions .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getNorthBTracedFootpointRegions[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getNorthBTracedFootpointRegions()

Gets the north B traced regions values.

Return value

::: small a strarr containing north B traced regions values or the constant scalar ” if there are no values. ::: :::

::: {#SpdfSatelliteData::getSouthBTracedFootpointRegions .routine-details .details}

top{.top} source{.top} SpdfSatelliteData::getSouthBTracedFootpointRegions[]{.routine-attributes}

[result]{.var} = SpdfSatelliteData::getSouthBTracedFootpointRegions()

Gets the south B traced regions values.

Return value

::: small a strarr containing south B traced regions values or the constant scalar ” if there are no values. ::: :::

::: {#SpdfSatelliteData__define .routine-details .details}

top{.top} source{.top} SpdfSatelliteData__define[]{.routine-attributes}

SpdfSatelliteData__define

Defines the SpdfSatelliteData class.

::: :::

::: {#attributes}

File attributes

Modification date: Fri May 13 08:54:13 2022 Lines: 250

:::

SSC Feedback. :::

::: footer

Produced by IDLdoc 3.6.4 on Mon Apr 8 09:51:01 2024 IDLdoc project information{target=“_top”}

:::