This page was created by the IDL library routine
mk_html_help2
.
Last modified: Wed Feb 14 14:08:15 2007.
Procedure: THM_CAL_EFI Purpose: Converts raw EFI (V, EDC, and EAC waveform) data into physical quantities. keywords: /VERBOSE or VERBOSE=n ; set to enable diagnostic message output. higher values of n produce more and lower-level diagnostic messages. /ALL Example: thm_cal_efi, /all Notes: -- fixed, nominal calibration pars used (gains and frequency responses), rather than proper time-dependent parameters. $LastChangedBy: jbonnell $ $LastChangedDate: 2007-02-07 17:32:28 -0800 (Wed, 07 Feb 2007) $ $LastChangedRevision: 323 $ $URL $
(See themis/spacecraft/fields/thm_cal_efi.pro)
Procedure: THM_CAL_FBK Purpose: Converts raw FBK (Filter Bank) data into physical quantities. keywords: /VERBOSE or VERBOSE=n ; set to enable diagnostic message output. higher values of n produce more and lower-level diagnostic messages. /ALL Example: thm_cal_fbk, /all Notes: -- Changes between signal sources are handled; source info from HED data should be used to get actual units of a given spectrum. -- fixed, nominal calibration pars used (gains and frequency responses), rather than proper time-dependent parameters. $LastChangedBy: jimm $ $LastChangedDate: 2007-02-13 14:29:46 -0800 (Tue, 13 Feb 2007) $ $LastChangedRevision: 408 $ $URL $
(See themis/spacecraft/fields/thm_cal_fbk.pro)
procedure: thm_cal_fgm Purpose: applies calibration to THEMIS fluxgate magnetometer data searches for the current calibration in ASCII file takes calibration that has time stamp before or at the start of the data converts data to nano Tessla applies the calibration corrects for phase shift from averaging before despinning INPUTS: name_thx_fgx_in --> input data (t-plot variable name) name_thx_fgx_hed --> header information for input data (t-plot variable name) name_thx_fgx_out --> name for output (t-plot variable name) pathfile --> path and filename of the calibration file keywords: /fgh : calibrates high res data /fgl : calibrates fgl-data Example: tha_cal_fgm('tha_fgl','tha_fgl_hed','tha_fgl_ssl','C:\Themis\calfiles\tha_V01.cal',/fgl) Notes: under construction!! Written by Hannes Schwarzl $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-02-02 11:35:42 -0800 (Fri, 02 Feb 2007) $ $LastChangedRevision: 277 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/fields/thm_cal_fgm.pro $
(See themis/spacecraft/fields/thm_cal_fgm.pro)
Procedure: THM_CAL_FIT Purpose: Converts raw FIT parameter data into physical quantities. keywords: /VERBOSE or VERBOSE=n ; set to enable diagnostic message output. higher values of n produce more and lower-level diagnostic messages. /ALL Example: thm_cal_fit, /all Notes: -- FGM range changes are not handled properly; RANGE=0 is assumed. -- fixed, nominal calibration pars used, rather than proper time-dependent parameters. $LastChangedBy: jimm $ $LastChangedDate: 2007-02-13 14:29:46 -0800 (Tue, 13 Feb 2007) $ $LastChangedRevision: 408 $ $URL $
(See themis/spacecraft/fields/thm_cal_fit.pro)
Procedure: thm_get_efi_cal_pars Purpose: Given the particular EFI waveform data type, and begin and end of the time interval, return the waveform RAW->PHYS transformation parameters. Calling Sequence: thm_get_efi_cal_pars, tbeg, tend, name, cal_pars=cal_pars Arguements: tbeg, tend DOUBLE, time in seconds since THEMIS epoch. name STRING, waveform data type indicator. cal_pars STRUCT, see Notes below for elements. Notes: -- use of TBEG and TEND for time-dependent calibration parameters is not currently implemented! -- E-field gains and units are for voltages, not fields, since we have not deployed yet! -- Difference in gain between DC and AC coupled E-field data not implemented yet! -- Elements of cal_pars are as follows: gain, FLOAT[ 3 or 6], gain of source channel at DC in (phys unit)/ADC. offset, FLOAT[ 3 or 6], offset of channel in ADC. $LastChangedBy: jbonnell $ $LastChangedDate: 2007-02-07 17:33:39 -0800 (Wed, 07 Feb 2007) $ $LastChangedRevision: 324 $ $URL $
(See themis/spacecraft/fields/thm_get_efi_cal_pars.pro)
Procedure: thm_get_fbk_cal_pars Purpose: Given the signal source, and begin and end of the time interval, return the filter bank RAW->PHYS transformation parameters. Calling Sequence: thm_get_fbk_cal_pars, tbeg, tend, fb_sel, cal_pars=cal_pars Arguements: tbeg, tend DOUBLE, time in seconds since THEMIS epoch. fb_sel INT, FilterBank source selection indicator. cal_pars STRUCT, see Notes below for elements. Notes: -- use of TBEG and TEND for time-dependent calibration parameters is not currently implemented! -- E-field gains and units are for voltages, not fields, since we have not deployed yet! -- Elements of cal_pars are as follows: gain, FLOAT, gain of source channel at 0 dB response in (phys unit)/ADC. freq_resp FLOAT[ 6], effective attenuation factor for source channel for each of the six FilterBank channels. $LastChangedBy: jbonnell $ $LastChangedDate: 2007-02-02 15:54:14 -0800 (Fri, 02 Feb 2007) $ $LastChangedRevision: 280 $ $URL $
(See themis/spacecraft/fields/thm_get_fbk_cal_pars.pro)
Procedure: THM_LOAD_EFI Purpose: Loads THEMIS EFI 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. /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 Example: thg_load_efi,/get_suppport_data,probe=['a', 'b'] Notes: $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-02-05 15:38:12 -0800 (Mon, 05 Feb 2007) $ $LastChangedRevision: 296 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/fields/thm_load_efi.pro $
(See themis/spacecraft/fields/thm_load_efi.pro)
Procedure: THM_LOAD_FBK Purpose: Loads THEMIS FilterBank 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. /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 Example: thg_load_fbk,/get_suppport_data,probe=['a', 'b'] Notes: $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-02-05 16:33:25 -0800 (Mon, 05 Feb 2007) $ $LastChangedRevision: 297 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/fields/thm_load_fbk.pro $
(See themis/spacecraft/fields/thm_load_fbk.pro)
Procedure: THM_LOAD_FFT Purpose: Loads THEMIS FFT spectra (ParticleBurst and WaveBurst) 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. /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 Example: thg_load_fft,/get_suppport_data,probe=['a', 'b'] Notes: $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-02-05 16:33:25 -0800 (Mon, 05 Feb 2007) $ $LastChangedRevision: 297 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/fields/thm_load_fft.pro $
(See themis/spacecraft/fields/thm_load_fft.pro)
Procedure: THM_LOAD_FGM Purpose: Loads THEMIS fluxgate magnetometer 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 'fgm', 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. 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 varible for output of pathnames of local files. Example: thg_load_fgm,probe=['a','b'] Notes: This routine is (should be) platform independent. $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-02-08 09:48:04 -0800 (Thu, 08 Feb 2007) $ $LastChangedRevision: 328 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/fields/thm_load_fgm.pro $
(See themis/spacecraft/fields/thm_load_fgm.pro)
Procedure: THM_LOAD_FIT Purpose: Loads THEMIS FIT 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. /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 Example: thg_load_fit,/get_suppport_data,probe=['a', 'b'] Notes: $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-02-05 16:33:25 -0800 (Mon, 05 Feb 2007) $ $LastChangedRevision: 297 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/fields/thm_load_fit.pro $
(See themis/spacecraft/fields/thm_load_fit.pro)
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. /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 Example: thg_load_scm,/get_suppport_data,probe=['a', 'b'] Notes: This routine is (should be) platform independent. $LastChangedBy: kenb-mac $ $LastChangedDate: 2007-02-05 16:33:25 -0800 (Mon, 05 Feb 2007) $ $LastChangedRevision: 297 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/thmsoc/trunk/idl/themis/spacecraft/fields/thm_load_scm.pro $
(See themis/spacecraft/fields/thm_load_scm.pro)
Function: THM_UNPACK_HED thm_unpack_hed, data_type, hed_array Purpose: Unpacks data packed into HED data. Arguements: DATA_TYPE STRING, one of the L1 data types (eff, scp, fbk, etc.) HED_ARRAY BYTE[ N, 16], array of header data. keywords: None. Example: get_data, 'tha_fit_hed', data=d_hed hed_data = thm_unpack_hed( 'fit', d_hed.y) Notes: -- Returns int( 0) if requested DATA_TYPE is not implemented. -- Returns annonymous structure with variable elements if DATA_TYPE is recognized. -- Not all DATA_TYPEs are implemented; implemented data types (APIDs) listed below: FIT (on-board EFI and FGM spin fits, 410), FBK (FilterBank data, 440), EFI waveform (VA?, VB?, EF?; 441,442,443, 445,446,447, 449,44A,44B), SCM waveform (SCF, SCP, SCW; 444; 448; 44C), FGM waveform (FGL, FGH; 460, 461), FFT spectra (FFP, FFW; 44D, 44E). $LastChangedBy: jbonnell $ $LastChangedDate: 2007-01-31 14:59:16 -0800 (Wed, 31 Jan 2007) $ $LastChangedRevision: 261 $ $URL $
(See themis/spacecraft/fields/thm_unpack_hed.pro)