projects/barrel/
barrel_load_rcnt.pro
NAME: barrel_load_rcnt DESCRIPTION: CDF-to-TDAS import routine for BARREL (RCNT) data products REQUIRED INPUTS: none KEYWORD ARGUMENTS (OPTIONAL): PROBE: String [array] of BARREL identifiers (e.g., '1A', '1B'). Default is 'all' (i.e., all available payloads). May also be a single string delimited by spaces (e.g., '1A 1B'). DATATYPE: String [array] of BARREL datatype identifiers (e.g. '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: (passed through to 'cdf2tplot' and 'cdf_info_to_tplot') MAKE_MULTI_TPLOTVAR: (not implemented) VARFORMAT: String (passed through to 'cdf2tplot'). /VALID_NAMES: (not implemented) FILES: (not implemented) (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.93e KBY 08/28/2013 explicit support for 'support_data' (e.g., FrameGroup); support for noting VALID_MIN and VALID_MAX values Version 0.93d KBY 08/23/2013 quality indicator ("Q") renamed "Quality"; take unit labels from CDF metadata, update documentation. Version 0.93c KBY 08/23/2013 BARREL payload identifiers shortened to alphanumeric build order only (e.g., '1A', '1B'), following change to CDF naming convention Version 0.93a KBY 08/16/2013 specify default value for 'unit' Version 0.92 KBY 06/04/2013 introduced VERSION keyword Version 0.91c KBY 05/31/2013 handling of ISTP fill values Version 0.91b KBY 05/31/2013 check for and delete existing variables of same name Version 0.91a KBY 05/28/2013 added file_retrieve keywords (no_download/update/clobber) Version 0.90a KBY 04/22/2013 re-factoring of generic load actions; update CDF compatibility Version 0.83 KBY 11/28/2012 initial beta release Version 0.82 KBY 11/27/2012 debugging with updated CDF definitions Version 0.81 KBY 11/21/2012 new CDF definitions; updated treatment of PROBE keyword; distinction between L1 and L2 data product handling. 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_rcnt
barrel_load_rcnt, 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: | 98 |