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_cal_fgm.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 keywords: probe = Probe name. The default is 'all', i.e., calibrate data for 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, 'fge', 'fgh', or 'fgl'. If name_thx_fgx_in,name_thx_fgx_hed, or name_thx_fgx_out,$ are specified, then this keyword is required. 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. coord = apply thm_cotrans if output other than spinning spacecraft (SSL) is desired. cal_dac_offset = apply calibrations that remove digital analog converter nonlinearity by addition of offset. Algorithm generated by Dragos Constantine . This is the default process as of 7-Jan-2010, to disable, explicitly set this keyword to 0. cal_spin_harmonics = apply calibrations from a file that remove spin harmonics by applying spin-dependent offsets generated by David Fischer . This is the default process as of 7-Jan-2010, to disable, explicitly set this keyword to 0. cal_tone_removal = fitting algorithm removes orbit dependent spintone without removing scientifically salient features. Algorithm generated by Ferdinand Plaschke . This is the default process as of 7-Jan-2010, to disable, explicitly set this keyword to 0. cal_get_fulloffset = returns the offset used for spintone removal.(this keyword used for valididation) Because there may be a different offset for each combination of probe and datatype, This is returned as a struct of structs, with each element in the child structs being an N by 3 array. For example, if offset_struct is the name of a struct with the return value from the cal_get_fulloffset keyword, print,offset_struct.tha.fgl Will print the fulloffset for probe a and datatype fgl. cal_get_dac_dat = Returns the raw data from directly after the DAC(non-linearity offset) calibration is applied. For verification. cal_get_spin_dat = Returns the raw data from directly after the spin harmonic(solar array current) calibration is applied. For verification. 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. optional parameters: 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: Example: tha_cal_fgm, probe = 'a', datatype= 'fgl' Notes: under construction!! Written by Hannes Schwarzl. $LastChangedBy: jwl $ $LastChangedDate: 2014-01-09 12:57:27 -0800 (Thu, 09 Jan 2014) $ $LastChangedRevision: 13833 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/fields/thm_cal_fgm.pro $ Changes by Edita Georgescu eg 6/3/2007 - matrix multiplication eg 30/3/2007 - keyword deleted, fgmtype determined from: name_thx_fgx_in - calibrates fgl,fgh,fge - calibrate only mode=0 data 2007-03-30 Modified by Hannnes S to use multiple calibrations for a selected interval and use spinperiod from the statefile Search this string to see changes ;Hannes 30/3/2007 2007-03-30 Modified by Hannnes S correction for filter delay removed Search this string to see changes: Hannes 05/21/2007

Routines

top source thm_cal_fgm

thm_cal_fgm, name_thx_fgx_in, name_thx_fgx_hed, name_thx_fgx_out, pathfile, probe=probe, datatype=datatype, in_suffix=in_suffix, out_suffix=out_suffix, coord=coord, interpolate_state=interpolate_state, cal_spin_harmonics=cal_spin_harmonics, cal_dac_offset=cal_dac_offset, cal_tone_removal=cal_tone_removal, cal_get_fulloffset=cal_get_fulloffset, cal_get_dac_dat=cal_get_dac_dat, cal_get_spin_dat=cal_get_spin_dat, use_eclipse_corrections=use_eclipse_corrections

Parameters

name_thx_fgx_in
name_thx_fgx_hed
name_thx_fgx_out
pathfile

Keywords

probe
datatype
in_suffix
out_suffix
coord
interpolate_state
cal_spin_harmonics
cal_dac_offset
cal_tone_removal
cal_get_fulloffset
cal_get_dac_dat
cal_get_spin_dat
use_eclipse_corrections

File attributes

Modification date: Thu Feb 13 16:42:38 2014
Lines: 339