::: 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

./

spdfsscwsconjunctionexample.pro[]{.file-attributes}

::: {#file_comments} ::: small This program is an example to demonstrate calling the Satellite Situation Center’s REST Web Services from an L3Harris Interactive Data Language (IDL) program. It demonstrates the following:

Using the IDL/Python bridge to find magnetic field line conjunctions using the Python sscws library. The python sscws library is used because, at this time, the IDL sscws library lacks support for conjunction query requests.

To successfully run this program, you must do the following:

Configure your IDL environment to support the IDL to Python bridge as described in the IDL documentation.
Configure your Python environment to support the sscws library. That is, $ pip install sscws. ::: :::

Author information

Author

: B. Harris

: Copyright (c) 2021 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 spdfsscwsconjunctionexample.pro

[result]{.var} = SpdfGetExampleConjunctionRequest()

: Creates an example conjunction query request.

SpdfPrintConjunctionResult[, result]{.argument}

: Prints a Python Dict representation of a QueryResult as defined in SSC.xsd.

SpdfSscWsConjunctionExample

: This procedure is an example to demonstrate calling the SSC REST Web Services from an IDL program.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfGetExampleConjunctionRequest()

Creates an example conjunction query request. The object returned is a Python sscws.request QueryRequest object for use in the sscws.sscws.get_conjunctions() method. The query is for magnetic field line conjunctions of at least 2 THEMIS satellites with one of 4 THEMIS ground stations duing 2008 doy = 1 - 5.

Return value

::: small an example Python sscws.request QueryRequest. ::: :::

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

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

SpdfPrintConjunctionResult[, result]{.argument}

Prints a Python Dict representation of a QueryResult as defined in SSC.xsd.

Parameters

result [in type=hash ]{.smaller}

: QueryResult to print. :::

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

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

SpdfSscWsConjunctionExample

This procedure is an example to demonstrate calling the SSC REST Web Services from an IDL program. It demonstrates the following:

Using the IDL/Python bridge to find magnetic field line conjunctions using the Python sscws library. The python sscws library is used because, at this time, the IDL sscws library lacks support for conjunction query requests.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::