IDL Command: vso files
From RHESSI Wiki
(Difference between revisions)
(New page: = IDL Command: vso_files = == Purpose == vso_files allows searching the VSO from within an active SSW IDL session. It returns one or many HTTP links to data that match the given search cr...) |
m (Put Requirements before Description) |
||
| (5 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | |||
| - | |||
== Purpose == | == Purpose == | ||
| - | vso_files allows searching the VSO from within an active SSW IDL session. It returns | + | ''vso_files'' allows searching the VSO from within an active SSW IDL session. It returns HTTP links to data that match the specified search criteria. ''vso_files'' allows for time and instrument based search. See [[vso_search]] for the more configurable VSO search routine. |
| + | |||
| + | == Requirements == | ||
| + | * Up-to-date SSW gen tree, [http://hesperia.gsfc.nasa.gov/rhessidatacenter/software/installation.html installation and download instructions] | ||
== Description == | == Description == | ||
<source lang="ittvis_idl" enclose="div"> | <source lang="ittvis_idl" enclose="div"> | ||
; Routine syntax | ; Routine syntax | ||
| - | urls = vso_files(tstart, tend, instrument=instrument) | + | urls = [f]vso_files[/f](tstart, tend, instrument=instrument) |
</source> | </source> | ||
| - | + | ''tstart'' and ''instrument'' are mandatory parameters, ''tend'' is optional. If ''tend'' is not specified the search will return only the one HTTP link to the data file that is closest to ''tstart''. Otherwise, all data in the given interval are returned. | |
| - | {| border="1" cellspacing="0" cellpadding="5" align=" | + | {| border="1" cellspacing="0" cellpadding="5" align="left width="100%" |
| - | ! Keyword | + | ! style="background:#efefef;" | Keyword |
| - | ! Description | + | ! style="background:#efefef;" | Description |
| - | ! Example | + | ! style="background:#efefef;" | Example |
|- | |- | ||
| tstart | | tstart | ||
| - | | This is the start time for the search interval. If tend is not specified | + | | This is the start time for the search interval. If ''tend'' is not specified the date closest to ''tstart'' is returned. Time is in TAI. || '1-may-07', '21-apr-2009 10:01' |
| - | | '1-may-07', '21-apr-2009 10:01' | + | |
|- | |- | ||
| - | | tend | + | | tend || This is the end time for the search interval. Time is in TAI. |
| - | | This is the end time for the search interval. Time is in TAI. | + | |
| '2-may-2009' | | '2-may-2009' | ||
|- | |- | ||
| - | | instrument | + | | instrument || This parameter specifies the type of instrument to search for. See the [[VSO Instrument List]] for more information. |
| - | | This parameter specifies the type of instrument to search for. | + | |
| instrument='eit', instr='euvi' | | instrument='eit', instr='euvi' | ||
|} | |} | ||
| - | |||
| - | |||
| - | |||
== Troubleshooting == | == Troubleshooting == | ||
=== IDL error: Cannot connect to port 80 (and similar messages) === | === IDL error: Cannot connect to port 80 (and similar messages) === | ||
| - | + | Network timeouts can lead to this error. Try searching again later. | |
== Examples == | == Examples == | ||
| - | The following commands show how to search for data | + | The following commands show how to search for data using the VSO. |
<source lang="ittvis_idl"> | <source lang="ittvis_idl"> | ||
| - | ; This will return one HTTP link to | + | ; This will return one HTTP link to the EIT image closest to April 21, 2002 00:00 |
| - | file=vso_files('21-apr-2002', instr='eit') | + | file = [f]vso_files[/f]('21-apr-2002', instr='eit') |
; This will return HTTP links to EUVI images between April 21, 2002 10:10 and April 21, 2002 11:00 | ; This will return HTTP links to EUVI images between April 21, 2002 10:10 and April 21, 2002 11:00 | ||
| - | files=vso_files('21-apr-2002 10:10', '21-apr-2002 11:00', instrument='euvi') | + | files = [f]vso_files[/f]('21-apr-2002 10:10', '21-apr-2002 11:00', instrument='euvi') |
</source> | </source> | ||
Latest revision as of 21:13, 17 August 2010
Contents |
Purpose
vso_files allows searching the VSO from within an active SSW IDL session. It returns HTTP links to data that match the specified search criteria. vso_files allows for time and instrument based search. See vso_search for the more configurable VSO search routine.
Requirements
- Up-to-date SSW gen tree, installation and download instructions
Description
; Routine syntax
urls = vso_files(tstart, tend, instrument=instrument)
urls = vso_files(tstart, tend, instrument=instrument)
tstart and instrument are mandatory parameters, tend is optional. If tend is not specified the search will return only the one HTTP link to the data file that is closest to tstart. Otherwise, all data in the given interval are returned.
| Keyword | Description | Example |
|---|---|---|
| tstart | This is the start time for the search interval. If tend is not specified the date closest to tstart is returned. Time is in TAI. | '1-may-07', '21-apr-2009 10:01' |
| tend | This is the end time for the search interval. Time is in TAI. | '2-may-2009' |
| instrument | This parameter specifies the type of instrument to search for. See the VSO Instrument List for more information. | instrument='eit', instr='euvi' |
Troubleshooting
IDL error: Cannot connect to port 80 (and similar messages)
Network timeouts can lead to this error. Try searching again later.
Examples
The following commands show how to search for data using the VSO.
; This will return one HTTP link to the EIT image closest to April 21, 2002 00:00 file = vso_files('21-apr-2002', instr='eit') ; This will return HTTP links to EUVI images between April 21, 2002 10:10 and April 21, 2002 11:00 files = vso_files('21-apr-2002 10:10', '21-apr-2002 11:00', instrument='euvi')
