Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

projects/barrel/

barrel_preload_actions.pro


NAME: barrel_preload_actions DESCRIPTION: CDF-to-TDAS pre-import routine for BARREL data REQUIRED INPUTS: (see Required Keyword Arguments, below) **NOTE** 'barrel_preload_actions' is not intended to be a user-facing routine. Please use the BARREL master load routine 'barrel_load_data.pro', or individual load routines of form 'barrel_load_.pro' REQUIRED KEYWORD ARGUMENTS: VDATATYPES: String [array] of valid datatype identifiers, appropriate for desired datatype VLEVELS: String [array] of valid level codes, appropriate for desired datatype 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. 'FSPC'). 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: /GET_SUPPORT_DATA: Load support_data variables as well as data variables. TPLOTNAMES: (passed through to 'cdf2tplot' and 'cdf_info_to_tplot') VARFORMAT: String (passed through to 'cdf2tplot'). (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) RETURN VALUE: a structure, with tags 'level' and 'tplot_variables' -1, if required keyword (VLEVELS or VDATATYPES) not specified OUTPUTS: none STATUS: TO BE ADDED: n/a EXAMPLE: REVISION HISTORY: Version 0.96a KBY 07/04/2014 RC1; definitive campaign 2 payload list (+ fix for wildcarded looping) Version 0.95b KBY 12/29/2013 enable campaign 2 payloads Version 0.93e KBY 08/28/2013 updated 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.92d KBY 07/04/2013 improved handling of VERSION keyword (original not overwritten) Version 0.92c KBY 06/05/2013 sanitize PROBE arguments; update VERSION defaults Version 0.92b KBY 06/04/2013 introduced VERSION keyword, with default preference for 'v01' Version 0.91a KBY 05/28/2013 updated to reflect namechange from 'gps' to 'ephm'; added file_retrieve keywords (no_download/update/clobber) and create/update a local copy of !barrel to override global defaults Version 0.90b KBY 04/25/2013 make request DATATYPE a guaranteed scalar (like request LEVEL) Version 0.90a KBY 04/19/2013 re-factoring of generic pre-load and read actions from datatype specific load procedures

Routines

top source barrel_preload_actions

result = barrel_preload_actions(probe=probe, datatype=datatype, trange=trange, level=level, version=version, vdatatypes=vdatatypes, vlevels=vlevels, verbose=verbose, get_support_data=get_support_data, downloadonly=downloadonly, no_download=no_download, no_server=no_server, no_update=no_update, no_clobber=no_clobber, tplotnames=tplotnames, varformat=varformat, valid_names=valid_names, files=files)

Keywords

probe
datatype
trange
level
version
vdatatypes
vlevels
verbose
get_support_data
downloadonly
no_download
no_server
no_update
no_clobber
tplotnames
varformat
valid_names
files

File attributes

Modification date: Tue Oct 21 13:53:32 2014
Lines: 129