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_fgm.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, 'fge', 'fgh', or 'fgl'. '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 to read, 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. type= 'raw' or 'calibrated'. default is calibrated. coord= coordinate system of output. default is 'dsl' suffix= suffix to add to output data quantity (not added to support data) 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. /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. NOTE: The following keywords are only used if level=1 is set 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. Example: thg_load_fgm,probe=['a','b'] Notes: This routine is (should be) platform independent. $LastChangedBy: jwl $ $LastChangedDate: 2012-11-05 17:02:47 -0800 (Mon, 05 Nov 2012) $ $LastChangedRevision: 11187 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/fields/thm_load_fgm.pro $

Routines

Routines from thm_load_fgm.pro

result = thm_load_fgm_relpath(sname=sname, filetype=filetype, level=level, trange=trange, addmaster=addmaster, _extra=_extra)
thm_load_fgm_post, sname=sname, datatype=datatype, level=level, tplotnames=tplotnames, suffix=suffix, proc_type=proc_type, coord=coord, delete_support_data=delete_support_data, 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, _extra=_extra
thm_load_fgm, 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, 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, _extra=_extra

Routine details

top source thm_load_fgm_relpath

result = thm_load_fgm_relpath(sname=sname, filetype=filetype, level=level, trange=trange, addmaster=addmaster, _extra=_extra)

Keywords

sname
filetype
level
trange
addmaster
_extra

top source thm_load_fgm_post

thm_load_fgm_post, sname=sname, datatype=datatype, level=level, tplotnames=tplotnames, suffix=suffix, proc_type=proc_type, coord=coord, delete_support_data=delete_support_data, 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, _extra=_extra

Keywords

sname
datatype
level
tplotnames
suffix
proc_type
coord
delete_support_data
cal_spin_harmonics
cal_dac_offset
cal_tone_removal
cal_get_fulloffset
cal_get_dac_dat
cal_get_spin_dat
use_eclipse_corrections
_extra

top source thm_load_fgm

thm_load_fgm, 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, 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, _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
cal_spin_harmonics
cal_dac_offset
cal_tone_removal
cal_get_fulloffset
cal_get_dac_dat
cal_get_spin_dat
use_eclipse_corrections
_extra

File attributes

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