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.pro


Procedure: THM_LOAD_EFI Purpose: Loads THEMIS EFI 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 calibrate all raw quantites and also produce all _0 and _dot0 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. LEVEL: I/O, string. The level of the data, the default is 'l1', or level-1 data. A string (e.g., 'l2') or an integer can be used. Only one level can be specifed at a time. Set /VALID_NAMES to return the valid level names. CDF_DATA: Output, string. Named variable in which to return cdf data structure: only works for a single spacecraft and datafile name. VARNAMES: *** CDF_DATA must be present *** Output, string. Returns CDF variable names that were loaded. /GET_SUPPORT_DATA: Input, numeric, 0 or 1. Set to load support_data variables as well as data variables into tplot variables. /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. TYPE: Input, string. Set to 'calibrated' or 'raw'. 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 use_eclipse_corrections: Only applies when loading and calibrating Level 1 data. Defaults to 0 (no eclipse spin model corrections applied). use_eclipse_corrections=1 applies partial eclipse corrections (not recommended, used only for internal SOC processing). use_eclipse_corrections=2 applies all available eclipse corrections. ONTHEFLY_EDC_OFFSET:OUTPUT, float. Return the EDC offset array calculated on-the-fly in a structure (tag name = probe letter, subtagname =datatype). *** WARNING: This kw can use a lot of memory, if processing many datatypes, or long time periods. *** 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). Added _extra keyword to ease the passing of keywords to thm_cal_efi $LastChangedBy: nikos $ $LastChangedDate: 2014-02-14 10:22:23 -0800 (Fri, 14 Feb 2014) $ $LastChangedRevision: 14379 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/fields/thm_load_efi.pro $

Routines

top source thm_load_efi

thm_load_efi, probe=probe, datatype=datatype, trange=trange, level=level, verbose=verbose, downloadonly=downloadonly, no_download=no_download, type=type, coord=coord, varformat=varformat, cdf_data=cdf_data, get_support_data=get_support_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, use_eclipse_corrections=use_eclipse_corrections, onthefly_edc_offset=onthefly_edc_offset, _extra=_extra

Keywords

probe
datatype
trange
level
verbose
downloadonly
no_download
type
coord
varformat
cdf_data
get_support_data
varnames
valid_names
files
relpathnames_all
suffix
progobj
test
no_time_clip
use_eclipse_corrections
onthefly_edc_offset
_extra

File attributes

Modification date: Thu Mar 13 16:35:35 2014
Lines: 242