![[attach.png]](../../../../../idldoc-resources/attach.png)
projects/themis/spacecraft/particles/moments/
thm_load_mom.pro
Procedure: THM_LOAD_MOM Purpose: Loads THEMIS moments 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 '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. coord = (optional) String denoting coordinates system to transform valid 3-vectors into (e.g. 'gsm'). 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 variable for output of pathnames of local files. WARNING: performing operations on the file paths returned by this keyword will break abstraction. This can decrease the maintainability of code based upon thm_load_mom. /VERBOSE set to output some useful info raw if set, then load raw data, without calibrating type added for compatibility with other THM_LOAD routines, if set to 'raw', then load raw data with no calibration, otherwise the default is to load calibrated data. /NO_TIME_CLIP: Disables time clipping, which is the default /dead_time_correct: If set, then calculate dead time correction based on ESA moments Example: thm_load_mom,/get_suppport_data,probe=['a', 'b'] Notes: Written by Davin Larson Jan 2007. Updated keywords KRB Feb 2007 If you aren't getting data and can't figure out why try increasing your debug output level using: 'dprint,setdebug=3' New calibrations for ESA moments solar wind mode and non-solar wind mode added Jul 23,2010 by pcruce (under Jim McFadden's direction.) Detailed descriptions of methods in code. These updated calibrations correct most of the discrepancy between ground and on-board moments. Some uncorrectable difference remains because on-board calculations don't account for variation in energy sweep, different spacecraft potential, and efficiency. $LastChangedBy: jimm $ $LastChangedDate: 2014-12-08 10:30:21 -0800 (Mon, 08 Dec 2014) $ $LastChangedRevision: 16393 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/particles/moments/thm_load_mom.pro $
Routines
Routines from thm_load_mom.pro
thm_clip_moment, tplotnames=tplotnames, trange=trangethm_transform_moment, coord, quantity, trange=trange, probe=probe, prefix=prefix, suffix=suffix, state_loaded=state_loadedthm_store_moment, time, dens, flux, mflux, eflux, mag, prefix=prefix, suffix=suffix, mass=mass, raw=raw, quantity=quantity, tplotnames=tplotnames, probe=probe, use_eclipse_corrections=use_eclipse_correctionsthm_load_mom_cal_array, time, momraw, scpotraw, qf, shft, iesa_sweep, iesa_sweep_time, eesa_sweep, eesa_sweep_time, iesa_solarwind_flag, eesa_solarwind_flag, iesa_config, iesa_config_time, eesa_config, eesa_config_time, isst_config, isst_config_time, esst_config, esst_config_time, iesa_solarwind_time, eesa_solarwind_time, probe=probe, caldata=caldata, coord=coord, verbose=verbose, raw=raw, comptest=comptest, datatype=datatype, use_eclipse_corrections=use_eclipse_corrections, suffix=suffix, tplotnames=tplotnamesthm_load_mom, probe=probe, datatype=datatype, trange=trange, all=all, level=level, verbose=verbose, downloadonly=downloadonly, varnames=varnames, valid_names=valid_names, raw=raw, comptest=comptest, suffix=suffix, coord=coord, source_options=source_options, type=type, progobj=progobj, files=files, no_time_clip=no_time_clip, true_dsl=true_dsl, use_eclipse_corrections=use_eclipse_corrections, dead_time_correct=dead_time_correct
Routine details
top source thm_clip_moment
thm_clip_moment, tplotnames=tplotnames, trange=trange
Keywords
- tplotnames
- trange
top source thm_transform_moment
thm_transform_moment, coord, quantity, trange=trange, probe=probe, prefix=prefix, suffix=suffix, state_loaded=state_loaded
Parameters
- coord
- quantity
Keywords
- trange
- probe
- prefix
- suffix
- state_loaded
top source thm_store_moment
thm_store_moment, time, dens, flux, mflux, eflux, mag, prefix=prefix, suffix=suffix, mass=mass, raw=raw, quantity=quantity, tplotnames=tplotnames, probe=probe, use_eclipse_corrections=use_eclipse_corrections
Parameters
- time
- dens
- flux
- mflux
- eflux
- mag
Keywords
- prefix
- suffix
- mass
- raw
- quantity
- tplotnames
- probe
- use_eclipse_corrections
top source thm_load_mom_cal_array
thm_load_mom_cal_array, time, momraw, scpotraw, qf, shft, iesa_sweep, iesa_sweep_time, eesa_sweep, eesa_sweep_time, iesa_solarwind_flag, eesa_solarwind_flag, iesa_config, iesa_config_time, eesa_config, eesa_config_time, isst_config, isst_config_time, esst_config, esst_config_time, iesa_solarwind_time, eesa_solarwind_time, probe=probe, caldata=caldata, coord=coord, verbose=verbose, raw=raw, comptest=comptest, datatype=datatype, use_eclipse_corrections=use_eclipse_corrections, suffix=suffix, tplotnames=tplotnames
Parameters
- time
- momraw
- scpotraw
- qf
- shft
- iesa_sweep
- iesa_sweep_time
- eesa_sweep
- eesa_sweep_time
- iesa_solarwind_flag
- eesa_solarwind_flag
- iesa_config
- iesa_config_time
- eesa_config
- eesa_config_time
- isst_config
- isst_config_time
- esst_config
- esst_config_time
- iesa_solarwind_time
- eesa_solarwind_time
Keywords
- probe
- caldata
- coord
- verbose
- raw
- comptest
- datatype
- use_eclipse_corrections
- suffix
- tplotnames
top source thm_load_mom
thm_load_mom, probe=probe, datatype=datatype, trange=trange, all=all, level=level, verbose=verbose, downloadonly=downloadonly, varnames=varnames, valid_names=valid_names, raw=raw, comptest=comptest, suffix=suffix, coord=coord, source_options=source_options, type=type, progobj=progobj, files=files, no_time_clip=no_time_clip, true_dsl=true_dsl, use_eclipse_corrections=use_eclipse_corrections, dead_time_correct=dead_time_correct
Keywords
- probe
- datatype
- trange
- all
- level
- verbose
- downloadonly
- varnames
- valid_names
- raw
- comptest
- suffix
- coord
- source_options
- type
- progobj
- files
- no_time_clip
- true_dsl
- use_eclipse_corrections
- dead_time_correct
File attributes
| Modification date: | Mon Dec 8 12:47:21 2014 |
| Lines: | 481 |