Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

external/spdfssc/

spdfgetlocations.pro


This file contains a procedure-oriented wrapper to a subset of functionality from the SpdfSsc class (IDL client interface to Satellite Situation Center Web Services (SSC WSs)) library.

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.

Routines

Routines from spdfgetlocations.pro

result = spdfFixCoordinateSystemCase(coordinateSystem)

Corrects the case of the given value.

result = SpdfGetLocations(satellite, timeSpan [, coordinateSystem=string] [, /quiet] [, httpErrorReporter=SpdfHttpErrorReporter])

This function gets basic location information for a single satellite from NASA's Space Physics Data Facility Satellite Situation Center.

Routine details

top source spdfFixCoordinateSystemCaseprivate

result = spdfFixCoordinateSystemCase(coordinateSystem)

Corrects the case of the given value.

Return value

a coordinate system identifier with the correct (camel) case. If the input value cannot be mapped to a valid coordinate system value, then an empty string ('') is returned.

Parameters

coordinateSystem in type=string

a coordinate system identifier.

top source SpdfGetLocations

result = SpdfGetLocations(satellite, timeSpan [, coordinateSystem=string] [, /quiet] [, httpErrorReporter=SpdfHttpErrorReporter])

This function gets basic location information for a single satellite from NASA's Space Physics Data Facility Satellite Situation Center. More comprehensive information if available by using SpdfSsc::getLocations().

Return value

SpdfLocations object containing requested data.

Parameters

satellite in type=string

identifies the satellite whose location is to be gotten.

timeSpan in type=strarr(2)

ISO 8601 format strings of the start and stop times of the data to get.

Keywords

coordinateSystem in optional type=string default='Gse'

specifies the coordinate system. Must be one of the following values: Geo, Gm, Gsm, Sm, GeiTod, or GeiJ2000.

quiet in optional type=boolean default=false

SpdfGetLocations normally prints an error message if no data is found. If QUIET is set, no error messages is printed.

httpErrorReporter in optional type=SpdfHttpErrorReporter

used to report an HTTP error.

Examples

     l = spdfGetLocations('ace',
           ['2013-01-01T00:00:00.000Z', '2013-01-03T00:00:00.000Z'])
     p = plot3d(l->getX(), l->getY(), l->getZ(), window_title='Orbit')
   

File attributes

Modification date: Thu Feb 13 16:41:58 2014
Lines: 110