Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/common/

thm_load_xxx.pro


Procedure: THM_LOAD_XXX Purpose: Generic THEMIS Data File Loading routine, meant to be called by type 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' /all_sites_in_one: set this if all sites are contained in a single file. 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 file_vdatatypes may contain a single name, rather than a list. 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. 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' 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. coord = coordinate system of data to be loaded. For L2, may be an array or space-separated list, which will checked against vL2coord. For L1, no checking: passed on to post_process_proc. 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. /DOWNLOADONLY: download file but don't read it. /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 suffix suffix to add to names of tplot variables loaded from CDF Note that the suffix is *not* applied to support_data. SCM_CAL: structure that contains calibration paramters msg_out: A named variable to output any useful error messages, messages can be printed to the console later when they will be more visible to the user. Notes: This routine is (should be) platform independent. $LastChangedBy: pcruce $ $LastChangedDate: 2014-01-08 16:26:27 -0800 (Wed, 08 Jan 2014) $ $LastChangedRevision: 13823 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/common/thm_load_xxx.pro $

Routines

top source thm_load_xxx

thm_load_xxx, sname=sname, datatype=datatype, trange=trange, level=level, coord=coord, proc_type=proc_type, version=version, verbose=verbose, downloadonly=downloadonly, cdf_data=cdf_data, get_cdf_data=get_cdf_data, get_support_data=get_support_data, varformat=varformat, tplotnames=tplotnames, valid_names=valid_names, files=files, type_sname=type_sname, vsnames=vsnames, vdatatypes=vdatatypes, file_vdatatypes=file_vdatatypes, vtypes=vtypes, vlevels=vlevels, deflevel=deflevel, vL2datatypes=vL2datatypes, vL2coord=vL2coord, file_vL2datatypes=file_vL2datatypes, relpath_funct=relpath_funct, cdf_to_tplot=cdf_to_tplot, post_process_proc=post_process_proc, addmaster=addmaster, midfix=midfix, no_download=no_download, relpathnames_all=relpathnames_all, all_sites_in_one=all_sites_in_one, suffix=suffix, progobj=progobj, scm_cal=scm_cal, no_update=no_update, alternate_load_params=alternate_load_params, no_time_clip=no_time_clip, no_implicit_wildcard=no_implicit_wildcard, use_eclipse_corrections=use_eclipse_corrections, msg_out=msg_out, _ref_extra=_ref_extra

Keywords

sname
datatype
trange
level
coord
proc_type
version
verbose
downloadonly
cdf_data
get_cdf_data
get_support_data
varformat
tplotnames
valid_names
files
type_sname
vsnames
vdatatypes
file_vdatatypes
vtypes
vlevels
deflevel
vL2datatypes
vL2coord
file_vL2datatypes
relpath_funct
cdf_to_tplot
post_process_proc
addmaster
midfix
no_download
relpathnames_all
all_sites_in_one
suffix
progobj
scm_cal
no_update
alternate_load_params
no_time_clip
no_implicit_wildcard
use_eclipse_corrections
msg_out
_ref_extra

File attributes

Modification date: Thu Feb 13 16:42:33 2014
Lines: 218