Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/spacecraft/fields/

thm_load_efi_l2.pro


Procedure: THM_LOAD_EFI_l2 Purpose: Loads THEMIS EFI level 2 data Syntax: THM_LOAD_EFI [, ] keywords: PROBE: Input, string. Specify space-separated probe letters, or string array (e.g., 'a c', ['a', 'c']). Defaults to all probes. DATATYPE: Input, string. Default setting is to load quantities. Use DATATYPE kw to narrow the data products. Wildcards and glob-style patterns accepted (e.g., ef?, *_dot0). SUFFIX: Input, scalar or array string. Set (scalar) to append SUFFIX to all output TPLOT variable names. Set (array with same # elements as COORD) to put suffixes for corresponding COORD elements (one TPLOT variable with suffix for each element of COORD). When COORD has > 1 element, SUFFIX must have the same # of elements (or be unset). TRANGE: Input, double (2 element array). Time range of interest. 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. /DOWNLOADONLY: Input, numeric, 0 or 1. Set to download file but not read it. /VALID_NAMES: Input, numeric, 0 or 1. 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: Output, string. Named varible for output of pathnames of local files. /VERBOSE: Input, numeric, 0 or 1. Set to output some useful info. /NO_DOWNLOAD: Input, numeric, 0 or 1. Set to use only files which are online locally. RELPATHNAMES_ALL: Output, string. Named variable in which to return all files that are required for specified timespan, probe, datatype, and level. If present, no files will be downloaded, and no data will be loaded. COORD: Input, string. What coordinate system you would like your data in. For choices, see THEMIS Sci. Data Anal. Software Users Guide. TEST: Input, numeric, 0 or 1. Disables selected /CONTINUE to MESSAGE. For QA testing only. /NO_TIME_CLIP: Disables time clipping, which is the default Example: thg_load_efi,/get_suppport_data,probe=['a', 'b'] Notes: Modifications: Added TEST kw to disable certain /CONTINUE to MESSAGE, and passed TEST through to THM_CAL_EFI.PRO, W.M.Feuerstein, 4/7/2008 (M). Fixed crash on passing an argument for RELPATHNAMES_ALL, WMF, 4/9/2008 (Tu). $LastChangedBy: aaflores $ $LastChangedDate: 2012-06-19 16:22:32 -0700 (Tue, 19 Jun 2012) $ $LastChangedRevision: 10594 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/fields/thm_load_efi_l2.pro $

Routines

top source thm_load_efi_l2

thm_load_efi_l2, probe=probe, datatype=datatype, trange=trange, level=level, verbose=verbose, downloadonly=downloadonly, no_download=no_download, coord=coord, varformat=varformat, cdf_data=cdf_data, varnames=varnames, valid_names=valid_names, files=files, relpathnames_all=relpathnames_all, suffix=suffix, progobj=progobj, test=test, no_time_clip=no_time_clip, msg_out=msg_out, _extra=_extra

Keywords

probe
datatype
trange
level
verbose
downloadonly
no_download
coord
varformat
cdf_data
varnames
valid_names
files
relpathnames_all
suffix
progobj
test
no_time_clip
msg_out
_extra

File attributes

Modification date: Thu Feb 13 16:42:38 2014
Lines: 131