Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/spacecraft/

thm_load_scmode.pro


Procedure: THM_LOAD_SCMODE, thm_load_scmode, datatype = datatype, $ probe = probe, $ trange = trange, $ verbose = verbose, $ varname_out = varname_out, $ downloadonly = downloadonly, $ no_download=no_download, relpathnames_all=relpathnames_all,$ files=files,$ valid_names = valid_names,$ suffix=suffix Purpose: Loads spacecraft mode data from CDF. Quantities for each mode will have a 0 at the beginning and end of each interval where a mode is off and a 1 at the beginning and end of each interval where a mode is on. keywords: probe = The probe to be loaded. Can be 'a','b','c','d','e' datatype = The type of data to be loaded. Can be 'ss','fs','pb','wb',or 'all' 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 = ignored, only one level for this datatype: L1 /VERBOSE : set to output some useful info varname_out= a string array containing the tplot variable names for the loaded data /downloadonly, if set, then only download the data, do not load it into variables. /no_download: use only files which are online locally. 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. files named varible for output of pathnames of local files. /valid_names, if set, then this will return the valid site, datatype and/or level options in named variables, for example, thm_load_gmag, site = xxx, /valid_names will return the array of valid sites in the variable xxx suffix= suffix to add to output data quantity (not added to support data) no_time_clip=no_time_clip, unlike other routines, no_time_clip is set by default, because clipping causes errors due to the way that scmode data is stored. To enable time clipping, call thm_load_scmode,no_time_clip=0 Examples: timespan,'2007-03-23' thm_load_scmode thm_load_scmode,probe='a',trange=['2007-01-22/00:00:00','2007-01-24/00:00:00'] $LastChangedBy: pcruce $ $LastChangedDate: 2012-11-15 14:57:31 -0800 (Thu, 15 Nov 2012) $ $LastChangedRevision: 11243 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/thm_load_scmode.pro $

Routines

Routines from thm_load_scmode.pro

result = thm_load_scmode_relpath(trange=trange, probe=probe)
thm_load_scmode, datatype=datatype, trange=trange, verbose=verbose, probe=probe, varname_out=varname_out, downloadonly=downloadonly, no_download=no_download, level=level, relpathnames_all=relpathnames_all, files=files, valid_names=valid_names, suffix=suffix, no_time_clip=no_time_clip

Routine details

top source thm_load_scmode_relpath

result = thm_load_scmode_relpath(trange=trange, probe=probe)

Keywords

trange
probe

top source thm_load_scmode

thm_load_scmode, datatype=datatype, trange=trange, verbose=verbose, probe=probe, varname_out=varname_out, downloadonly=downloadonly, no_download=no_download, level=level, relpathnames_all=relpathnames_all, files=files, valid_names=valid_names, suffix=suffix, no_time_clip=no_time_clip

Keywords

datatype
trange
verbose
probe
varname_out
downloadonly
no_download
level
relpathnames_all
files
valid_names
suffix
no_time_clip

File attributes

Modification date: Thu Feb 13 16:42:52 2014
Lines: 92