projects/barrel/
barrel_load_data.pro
NAME: barrel_load_data DESCRIPTION: master CDF-to-TDAS import routine for BARREL data products REQUIRED INPUTS: none KEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL launch order designators (e.g. '101'). Default is 'all' (i.e., all available payloads). May also be a single string delimited by spaces (e.g., '101 102'). If string contains two character alphanumeric identifiers (e.g., '1A 1B'), then PROBE is assumed to specify a build order designator instead. DATATYPE: String [array] of BARREL datatype identifiers (e.g. 'MAGN', 'FSPC','MSPC','SSPC','HKPG','GPS','PPS','RCNT'). TRANGE: Time range for tplot (2 element array). Loads data in whole-day chunks, and will prompt user if not specified. LEVEL: String [array] of data level code (e.g. 'l1', 'l2'). VERSION: String specifying data revision number (e.g. 'v01', 'v02'). /VERBOSE: CDF_DATA: (not implemented) /GET_SUPPORT_DATA: Load support_data variables as well as data variables. TPLOTNAMES: if specified, a named variable into which a list of TPLOT variable names is written immediately after import. MAKE_MULTI_TPLOTVAR: (not implemented) VARFORMAT: String (passed through to 'cdf2tplot'). /VALID_NAMES: (not implemented) FILES: if specified, a named variable into which a list of source filenames is written. (FILE_RETRIEVE KEYWORDS-- descriptions borrowed from file_retrieve.pro) /DOWNLOADONLY: Set to 1 to only download files but not load files into memory. /NO_SERVER: Set to 1 to prevent any contact with a remote server. /NO_DOWNLOAD: Identical to NO_SERVER keyword. Obsolete, but retained for backward compatibility /NO_UPDATE: Set to 1 to prevent contact to server if local file already exists. (this is similar to no_clobber) /NO_CLOBBER: Set to 1 to prevent existing files from being overwritten. (A warning message will be displayed if remote server has) OUTPUTS: none STATUS: TO BE ADDED: n/a EXAMPLE: REVISION HISTORY: Version 0.96a KBY 07/07/2014 RC1, defaults to v03 dataset Version 0.95b KBY 12/29/2013 default to v02 dataset Version 0.93e KBY 08/16/2013 rename "barrel_load_gps.pro" to "barrel_load_ephm.pro"; DROP SUPPORT/COMPATIBILITY FOR v01 CDFs Version 0.93a KBY 08/16/2013 deprecate "PPS-" datatype in favor of "MISC" Version 0.92c KBY 06/05/2013 string-split input of LEVEL; make VERSION scalar string Version 0.92a KBY 06/04/2013 introduced VERSION keyword Version 0.91a KBY 05/28/2013 updated to reflect namechange from 'gps' to 'ephm'; added file_retrieve keywords (no_download/update/clobber) Version 0.90a KBY 04/19/2013 updated for pending release of revised CDFs Version 0.83 KBY 11/28/2012 initial beta release Version 0.81 KBY 11/21/2012 new CDF definitions; updated treatment of PROBE keyword. Version 0.8 KBY 10/29/2012 from 'rbsp_load_efw_spec.pro' (Peter Schroeder), and 'thm_load_goesmag.pro'
Routines
top source barrel_load_data
barrel_load_data, probe=probe, datatype=datatype, trange=trange, level=level, version=version, verbose=verbose, downloadonly=downloadonly, no_download=no_download, no_server=no_server, no_update=no_update, no_clobber=no_clobber, cdf_data=cdf_data, get_support_data=get_support_data, tplotnames=tplotnames, make_multi_tplotvar=make_multi_tplotvar, varformat=varformat, valid_names=valid_names, files=files, CONVERT_L1_TO_PHYSICAL_UNITS=CONVERT_L1_TO_PHYSICAL_UNITS
Keywords
- probe
- datatype
- trange
- level
- version
- verbose
- downloadonly
- no_download
- no_server
- no_update
- no_clobber
- cdf_data
- get_support_data
- tplotnames
- make_multi_tplotvar
- varformat
- valid_names
- files
- CONVERT_L1_TO_PHYSICAL_UNITS
File attributes
Modification date: | Tue Oct 21 13:53:32 2014 |
Lines: | 132 |