Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/state/

thm_load_state.pro


Procedure: THM_LOAD_STATE Purpose: Loads THEMIS STATE (orbit and attitude) 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, can be an array of strings or single string separate by spaces. The default is 'pos vel' 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 version = the version of the state file, one of 'v00', 'v01', 'v02', 'v03'. defaults to 'v01' 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. suffix= suffix to add to tplot variable names. Note: this will get added support_data variables as well as regular data variables. 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_download: use only files which are online locally. /NO_UPDATE: prevent contact to server if local file already exists. relpathnames_all: 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. /valid_names, if set, then this routine will return the valid probe, datatype level, and version 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 coord: Can specify the coordinate system you would like data returned in. no_spin: if set, do not call thm_load_spin to load spinmodel data. Example: thm_load_state Notes: Modifications: If /GET_SUPPORT_DATA and ~/NO_SPIN, then call THM_LOAD_SPIN, W.M.Feuerstein, 4/10/2008. Delete th?_spin* TPLOT variables after calling THM_LOAD_SPIN (as long as ~/KEEP_SPIN_DATA), add KEEP_SPIN_DATA kw, include a couple of (normally commented) lines to chck consistency of spinmodel, WMF, 4/10/08. coordinate systems of returned variables: *_pos : gei *_vel : gei *_ras : gei *_dec : gei *_alpha : spg *_beta : spg *_spinper : none(listed in dlimits as unknown) *_spinphase : none(listed in dlimits as unknown) *_roi : none(listed in dlimits as unknown) *_man : none(listed in dlimits as unknown) If you modify the d_names constant make sure to make the corresponding changes to the c_names constant $LastChangedBy: jwl $ $LastChangedDate: 2014-06-10 16:56:01 -0700 (Tue, 10 Jun 2014) $ $LastChangedRevision: 15342 $ $URL $

Routines

Routines from thm_load_state.pro

thm_load_state_post, sname=sname, datatype=datatype, level=level, tplotnames=tplotnames, suffix=suffix, proc_type=proc_type, coord=coord, delete_support_data=delete_support_data, c_names=c_names, d_names=d_names, u_names=u_names, get_support_data=get_support_data, no_spin=no_spin, keep_spin_data=keep_spin_data, trange=trange, _extra=_extra
thm_load_state, 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, version=version, suffix=suffix, progobj=progobj, coord=coord, no_spin=no_spin, keep_spin_data=keep_spin_data, no_update=no_update

Routine details

top source thm_load_state_post

thm_load_state_post, sname=sname, datatype=datatype, level=level, tplotnames=tplotnames, suffix=suffix, proc_type=proc_type, coord=coord, delete_support_data=delete_support_data, c_names=c_names, d_names=d_names, u_names=u_names, get_support_data=get_support_data, no_spin=no_spin, keep_spin_data=keep_spin_data, trange=trange, _extra=_extra

Keywords

sname
datatype
level
tplotnames
suffix
proc_type
coord
delete_support_data
c_names
d_names
u_names
get_support_data
no_spin
keep_spin_data
trange
_extra

top source thm_load_state

thm_load_state, 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, version=version, suffix=suffix, progobj=progobj, coord=coord, no_spin=no_spin, keep_spin_data=keep_spin_data, no_update=no_update

Keywords

probe
datatype
trange
level
verbose
downloadonly
relpathnames_all
no_download
cdf_data
get_support_data
varnames
valid_names
files
version
suffix
progobj
coord
no_spin
keep_spin_data
no_update

File attributes

Modification date: Tue Oct 21 13:53:34 2014
Lines: 270