projects/themis/spacecraft/fields/
thm_load_scm.pro
Routines
Routines from thm_load_scm.pro
thm_load_scm_post, sname=sname, datatype=datatype, level=level, tplotnames=tplotnames, progobj=progobj, suffix=suffix, proc_type=proc_type, coord=coord, trange=trange, delete_support_data=delete_support_data, use_eclipse_corrections=use_eclipse_corrections, _extra=_extra, scm_cal=scm_cal
Procedure: THM_LOAD_SCMPurpose: Loads THEMIS SCM datakeywords: probe = Probe name.
thm_load_scm, 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, scm_cal=scm_cal, use_eclipse_corrections=use_eclipse_corrections, _extra=_extra
Routine details
top source thm_load_scm_post
thm_load_scm_post, sname=sname, datatype=datatype, level=level, tplotnames=tplotnames, progobj=progobj, suffix=suffix, proc_type=proc_type, coord=coord, trange=trange, delete_support_data=delete_support_data, use_eclipse_corrections=use_eclipse_corrections, _extra=_extra, scm_cal=scm_cal
Procedure: THM_LOAD_SCM Purpose: Loads THEMIS SCM 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 '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 = 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. 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. 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 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, set to 0 to or 1 to reduce output. CLEANUP: Pass through to THM_CAL_SCM.PRO. SCM_CAL: Structure containing the calibration parameters /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. KEYWORDS FOR CALIBRATION PROCESS: These are passed through to the THM_SCM_CAL procedure: in_suffix = optional suffix to add to name of input data quantity, which is generated from probe and datatype keywords. out_suffix = optional suffix to add to name for output tplot quantity, which is generated from probe and datatype keywords. trange= array[2] string or double. Limit calibration to specified time range nk = N points of the cal-convolution kernel, if set, this value will be used regardless of sample rate. mk = If nk is not set, set nk to (sample frequency)*mk, where sample frequency is determined by the data. default 8 for scf, 4 for scp, and 1 for scw. despin =classic despin algorithm. 0:off 1:on Default is on. n_spinfit=n spins to fit for misalignment, dc field calculation and optionally despin. cleanup= type of cleanup (default is 'none'): 'spin' for only spin tones (power ripples) cleanup, 'full' for spin tones and 8/32 Hz tones 'none' for no cleanup processes. wind_dur_1s = window duration for 8/32 Hz cleanup (has to be a multiple of 1s) default is 1. wind_dur_spin = spintone cleanup window duration as a multiple of the spin period. Default is 1. clnup_author = choice of cleanup routine (default is 'ole'): 'ccc' to use scm_cleanup_ccc 'ole' to use spin_tones_cleaning_vector_v5 fdet = detrend freq. in Hz. Detrend is implemented by subtracting a boxcar avg., whose length is determined by fdet. Use fdet=0 for no detrending. Default is fdet=0. fcut = Low Frequency cut-off for calibration. Default is 0.1 Hz. fmin = Min frequency for filtering in DSL system. Default is 0 Hz. fmax = Max frequency for filtering in DSL system. Default is Nyquist. step = Highest Processing step to complete. Default is step 5. dfb_butter = correct for DFB Butterworth filter response (defaut is true) dfb_dig = correct for DFB Digital fiter response (default is true) gainant = correct for antenna gain (default is true) blk_con = use fast convolution for calibration and filtering. Block size for fast convolution will be equal to (value of blk_con) * (size of kernel). blk_con = 8 by default. set blk_con=0 to use brute-force convolution. edge_truncate, edge_wrap, edge_zero= Method for handling edges in step 3, cal-deconvolution. For usage and exact specification of these keywords, see docs for IDL convol function. Default is to zero data within nk/2 samples of data gap or edge. coord = coordinate system of output. Step 6 output can only be in DSL. no_download=don't access internet to check for updated calibration files. dircal= If set to a string, specifies directory of calibration files. use /dircal or dircal='' to use calibration files in IDL source distribution. Example: thg_load_scm,level=1,/get_suppport_data,probe=['a', 'b'] Notes: This routine is (should be) platform independent. Modifications: Added CLEANUP kw to pass through to THM_CAL_SCM.PRO, W.Michael Feuerstein, 4/21/2008. 30-may-2008 cg, added optional keyword SCM_CAL which is a structure containing all the calibration parameters. modified the call to thm_cal_scm so that parameters can be used. 23-jul-2008, jmm, added _extra to allow SCM cal keywords to allow cal parameters to be set from the command line, also fixed bug where program would crash when called from the command line. Re-tabbed, to find an 'End of file encountered...' bug. $LastChangedBy: jimm $ $LastChangedDate: 2014-06-27 12:48:02 -0700 (Fri, 27 Jun 2014) $ $LastChangedRevision: 15455 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/fields/thm_load_scm.pro $
Keywords
- sname
- datatype
- level
- tplotnames
- progobj
- suffix
- proc_type
- coord
- trange
- delete_support_data
- use_eclipse_corrections
- _extra
- scm_cal
top source thm_load_scm
thm_load_scm, 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, scm_cal=scm_cal, use_eclipse_corrections=use_eclipse_corrections, _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
- scm_cal
- use_eclipse_corrections
- _extra
File attributes
Modification date: | Tue Oct 21 13:53:34 2014 |
Lines: | 219 |