projects/themis/common/
thm_load_proc_arg.pro
Routines
top source thm_load_proc_arg
thm_load_proc_arg, sname=sname, datatype=datatype, level=level, coord=coord, proc_type=proc_type, verbose=verbose, varformat=varformat, valid_names=valid_names, type_sname=type_sname, vsnames=vsnames, vdatatypes=vdatatypes, file_vdatatypes=file_vdatatypes, vtypes=vtypes, deftype=deftype, vlevels=vlevels, deflevel=deflevel, vL2datatypes=vL2datatypes, vL2coord=vL2coord, file_vL2datatypes=file_vL2datatypes, no_download=no_download, progobj=progobj, osname=osname, odt=odt, olvl=olvl, my_themis=my_themis, oft=oft, ofdt=ofdt, otyp=otyp, no_update=no_update, load_params=load_params, use_eclipse_corrections=use_eclipse_corrections, msg_out=msg_out, _ref_extra=_ref_extra
Procedure: THM_LOAD_PROC_ARG Purpose: Generic argument validation routine for THEMIS Data File Loading routines, meant to be called by instrument-specific thm_load procedures. keywords: post_process_proc: name of procedure to call after cdf2tplot is called will be called w/ keywords sname, dt (datatype), lvl, and _extra. relpath_funct: name of routine to call in place of file_dailynames may simply be a wrapper. will be called w/ keywords sname, dt (datatype), lvl, and _extra. cdf_to_tplot: user-supplied procedure to override cdf2tplot sname = site or probe name. The default is 'all', type_sname = string, set to 'probe' or 'site' vsnames = space-separated list of valid probes/sites datatype = Can be any datatype from the list of valid datatypes or 'all' vdatatypes = space-separated list of valid data types file_vdatatypes = space-separated list of file types corresponding to each valid data type. If there is a one-to-one correpspondence between filetype and datatype, vfiletypes may be left undefined. If all datatypes are in a single file, then vfiltypes may contain a single name, rather than a list. vL2datatypes= space-separated list of datatypes valid for L2 data vL2coord= space-separated list of coordinates valid for L2 data file_vL2datatypes=same as file_vdatatypes, but for L2 data. Defaults to value of file_vdatatypes. TRANGE= (Optional) Time range of interest (2 element array), if this is not set, the default is to prompt the user. Note that if the input time range is not a full day, a full day's data is loaded level = the level of the data, the default is 'l1', or level-1 data. A string (e.g., 'l2') or an integer can be used. 'all' can be passed in also, to get all levels. vlevels=A space-separated list of valid levels, e.g. 'l1 l2' proc_type = the type of data, i.e. 'raw' or 'calibrated'. This is for validating the 'type' keyword to thm_load procs. vtypes =A space-separated list of valid types, e.g. 'raw calibrated' No validation on proc_type if not set. deftype = default for type. only applied to L1. If not supplied, then 'calibrated' will be uses as the default value. CDF_DATA: named variable in which to return cdf data structure: only works for a single spacecraft and datafile name. VARNAMES: names of variables to load from cdf: default is all. /GET_SUPPORT_DATA: load support_data variables as well as data variables into tplot variables. /NO_UPDATE: prevent contact to server if local file already exists. /valid_names, if set, then this routine will return the valid probe, datatype and/or level options in named variables supplied as arguments to the corresponding keywords. files named varible for output of pathnames of local files. /VERBOSE set to output some useful info msg_out: A named variable to output an array of error messages which can be printed to the console later when they will be more visible to the user. Null string is returned if no applicable errors are encountered. Output Keywords: oft distinct file types that need to be loaded. Array of strings. ofdt datatypes corresponding to each file type in ofts. Array of strings, each containing a space-separate list of datatypes . odt validated datatypes olvl validated levels. otyp validated type. Notes: This routine is a utility function used to implement thm_load_??? routines. $LastChangedBy: aaflores $ $LastChangedDate: 2012-06-19 16:12:58 -0700 (Tue, 19 Jun 2012) $ $LastChangedRevision: 10591 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_load_proc_arg.pro $
Keywords
- sname
- datatype
- level
- coord
- proc_type
- verbose
- varformat
- valid_names
- type_sname
- vsnames
- vdatatypes
- file_vdatatypes
- vtypes
- deftype
- vlevels
- deflevel
- vL2datatypes
- vL2coord
- file_vL2datatypes
- no_download
- progobj
- osname
- odt
- olvl
- my_themis
- oft
- ofdt
- otyp
- no_update
- load_params
- use_eclipse_corrections
- msg_out
- _ref_extra
File attributes
Modification date: | Thu Feb 13 16:42:33 2014 |
Lines: | 156 |