Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/spacecraft/particles/

thm_load_esa.pro


Procedure: THM_LOAD_ESA Purpose: Loads THEMIS ESA data keywords: probe = Probe name. The default is 'all', i.e., load all available probes. This can be an array of strings, e.g., ['a', 'b'] or a single string delimited by spaces, e.g., 'a b' datatype = The type of data to be loaded, for this case, there is only one option, the default value of 'mom', so this is a placeholder should there be more that one data type. 'all' can be passed in also, to get all variables. 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 'l2', or level-2 data. A string (e.g., 'l2') or an integer can be used. 'all' can be passed in also, to get all levels. 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. /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 /NO_TIME_CLIP: Disables time clipping, which is the default Example: thg_load_esa,/get_suppport_data,probe=['a', 'b'] Notes: Written by Davin Larson, Dec 2006 Updated to use thm_load_xxx by KRB, 2007-2-5 Fixed bug in valid_names block, removed references to sst in coments jmm, 21-feb-2007 Fixed bugs, added ylim, zlim calls for spec data, as in thm_load_sst Handles new version of Level2 data files, jmm, 12-oct-2007 adds units and coordinates to all new variables, jmm, 24-feb-2008 $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-02-08 09:48:04 -0800 (Thu, 08 Feb 2007) $ $LastChangedRevision: 328 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/particles/thm_load_esa.pro $

Routines

Routines from thm_load_esa.pro

result = thm_load_esa_relpath(sname=sname, filetype=filetype, level=level, trange=trange, addmaster=addmaster, _extra=_extra)
thm_load_esa_post, sname=sname, datatype=datatype, level=level, tplotnames=tplotnames, suffix=suffix, proc_type=proc_type, coord=coord, delete_support_data=delete_support_data, _extra=_extra
thm_load_esa, probe=probe, datatype=datatype, trange=trange, level=level, verbose=verbose, downloadonly=downloadonly, relpathnames_all=relpathnames_all, no_download=no_download, cdf_data=cdf_data, get_support_data=get_support_data, varnames=varnames, valid_names=valid_names, files=files, suffix=suffix, type=type, coord=coord, progobj=progobj, _extra=_extra

Routine details

top source thm_load_esa_relpath

result = thm_load_esa_relpath(sname=sname, filetype=filetype, level=level, trange=trange, addmaster=addmaster, _extra=_extra)

Keywords

sname
filetype
level
trange
addmaster
_extra

top source thm_load_esa_post

thm_load_esa_post, sname=sname, datatype=datatype, level=level, tplotnames=tplotnames, suffix=suffix, proc_type=proc_type, coord=coord, delete_support_data=delete_support_data, _extra=_extra

Keywords

sname
datatype
level
tplotnames
suffix
proc_type
coord
delete_support_data
_extra

top source thm_load_esa

thm_load_esa, probe=probe, datatype=datatype, trange=trange, level=level, verbose=verbose, downloadonly=downloadonly, relpathnames_all=relpathnames_all, no_download=no_download, cdf_data=cdf_data, get_support_data=get_support_data, varnames=varnames, valid_names=valid_names, files=files, suffix=suffix, type=type, coord=coord, progobj=progobj, _extra=_extra

Keywords

probe
datatype
trange
level
verbose
downloadonly
relpathnames_all
no_download
cdf_data
get_support_data
varnames
valid_names
files
suffix
type
coord
progobj
_extra

File attributes

Modification date: Mon Jun 9 05:59:03 2014
Lines: 163