Changes between Initial Version and Version 1 of VsoIDL/VsoGet


Ignore:
Timestamp:
09/20/10 12:42:03 (14 years ago)
Author:
joe
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • VsoIDL/VsoGet

    v1 v1  
     1== VSO IDL Client Documentation : vso_search == 
     2 
     3For the time being (17 Sept 2010), this is basically just what you'd get from running `doc_menu, 'vso_search'` and `doc_menu, 'vso_get'`, but I hope to get a better list of real-world examples up. So, if you have a question about how to do something using the client, [wiki:People/JoeHourcle contact me], and I'll add to the list: 
     4 
     5{{{ 
     6;+ 
     7; Project     : VSO 
     8; 
     9; Name        : VSO_GET() 
     10; 
     11; Purpose     : Send a GetData request to VSO 
     12; 
     13; Explanation : Attempts to download data products corresponding to the 
     14;               metadata from a previous VSO search.  Also returns 
     15;               metadata about the files to be downloaded 
     16; 
     17; Category    : Utility, Class2, VSO 
     18; 
     19; Syntax      : IDL> a = vso_get( vso_search( date='2004.1.1', inst='eit' ) ) 
     20; 
     21; Examples    : IDL> meta = vso_search( date='2004.6.5', inst='eit', /FLAT ) 
     22;               IDL> wanted = where( meta.wave_min eq 171.0 ) 
     23;               IDL> results = vso_get( meta[wanted] ) 
     24;               IDL> print_struct, results 
     25; 
     26;               IDL> hmi = vso_search( '2010.09.01', inst='hmi', /LATEST ) 
     27;               IDL> b = vso_get( hmi, /RICE, out_dir='/tmp', filenames=files ) 
     28; 
     29;               IDL> aia = vso_search( inst='aia', wave=304, /LATEST, res=1 ) 
     30;               IDL> b = vso_get( aia, /NORICE, site='sao', out_dir='/tmp' ) 
     31; 
     32;               IDL> b = vso_get( vso_search( '2010.09.01', inst='aia', pix=1024, wave=193, $ 
     33;                    sample=900 ), /RICE, /FORCE ) 
     34 
     35; History     : Ver 0.1, 27-Oct-2005, J A Hourcle.  split this out from vso__define 
     36;               Ver 1,   08-Nov-2005, J A Hourcle.  Released 
     37;               Ver 1.1, 21-Nov-2005, Hourcle.  Added /DOWNLOAD flag 
     38;               Ver 1.2, 22-Nov-2005, Hourcle.  Replaced /DOWNLOAD flag w/ /NODOWNLOAD 
     39;               Ver 1.3  18-May-2006, Zarro. Added /NOWAIT and removed VSO_GET 
     40;                        procedure because it confused the compiler. 
     41;               Ver 2    24-July-2008, Zarro (ADNET) - added some error checking 
     42;               Ver 2.1  10-June-2010, Hourcle (Wyle) -- Default to HTTP/1.0 
     43;               Ver 2.2  06-July-2010, Hourcle.  Added /rice flag, 
     44;               warning re: downloads from SHA;    
     45;               Ver 2.3  21-July-2010, Zarro (ADNET). Changed _EXTRA to _REF_EXTRA 
     46;               Ver 2.4  13-Aug-2010, Hourcle.  Added FILENAMES,EMAIL and SITE keywords 
     47; 
     48; Contact     : oneiros@grace.nascom.nasa.gov 
     49;               http://virtualsolar.org/ 
     50; Inputs: 
     51;   ARGS : Can be one of: 
     52;     struct[n] : vsoRecord (returned from vso::query()) 
     53;     struct[n] : vsoFlatRecord (returned from vso::query(/FLAT)) 
     54;     struct[n] : datarequest (you probably don't want this) 
     55; Optional Keywords: (input) 
     56;   METHODS : string[n] : acceptable transfer methods 
     57;   OUT_DIR : string    : directory to download files to 
     58;   PROTOCOL: string    : to adjust the HTTP protocol used (default '1.0') 
     59;   SITE    : string    : the abbreviation of an SDO caching node (see below) 
     60;   EMAIL   : string    : to 'order' data from SHA (they will e-mail where you pick it up) 
     61;   ??      :           : any other input allowed by sock_copy 
     62; Optional Keywords: (output) 
     63;   FILENAMES : string[n] : returns the list of files downloaded 
     64; Flag Keywords: 
     65;   MERGE   : boolean   : if input is vsoRecord or vsoFlatRecord, 
     66;                          will insert URLs into the input structures 
     67;   FORCE   : boolean   : don't prompt for seemingly excessive requests 
     68;   QUIET   : boolean   : work silently (implies /FORCE, as well) 
     69;   NODOWNLOAD : bool.  : don't attempt to download files 
     70;   URLS    : boolean   : override METHODS to only use URL-type transfer methods. 
     71;   NOWAIT  : boolean   : download in background without waiting 
     72;   RICE    : boolean   : request Rice-compressed FITS files from SDO JSOC 
     73;   NORICE  : boolean   : make sure we don't get Rice-compressed files, should the default ever change 
     74;   STAGING : boolean   : prefer 'staged' data, rather than immediate URLs.  (requires EMAIL) 
     75 
     76; Output: 
     77;   struct[n] : getDataRecord 
     78 
     79; See Also: 
     80;   for more documentation, see vso__define.pro 
     81;   see also vso_search.pro (w. /URLS flag), and sock_copy.pro 
     82; 
     83; The 'SITES' keyword: 
     84;   There are a number of sites building caches for SDO data.  You can 
     85;   try specifying any of the following values, and we will re-route 
     86;   you to them as they become available. 
     87;     NSO   : National Solar Observatory, Tucson (US) 
     88;     SAO  (aka CFA)  : Smithonian Astronomical Observatory, Harvard U. (US) 
     89;     SDAC (aka GSFC) : Solar Data Analysis Center, NASA/GSFC (US) 
     90;     ORB  (aka ROB)  : Observatoire Royal de Belgique (Belgium) 
     91;     MPS   : Max Planck Institute for Solar System Research (Germany) 
     92;     UCLan : University of Central Lancashire (UK) 
     93;     IAS   : Institut Aeronautique et Spatial (France) 
     94;     KIS   : Kiepenheuer-Institut fur Sonnenphysik Germany) 
     95;     NMSU  : New Mexico State University (US) 
     96;- 
     97}}}