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_get_efi_cal_pars.pro


Routines

Routines from thm_get_efi_cal_pars.pro

result = thm_efi_cal_file_template()
thm_get_efi_cal_pars, times, name, probes, cal_pars=cal_pars, test=test

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.

Routine details

top source thm_efi_cal_file_template

result = thm_efi_cal_file_template()

top source thm_get_efi_cal_pars

thm_get_efi_cal_pars, times, name, probes, cal_pars=cal_pars, test=test

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, times, name, probes, cal_pars=cal_pars Arguements: TIMES: Input, DOUBLE, time basis of data since THEMIS epoch. NAME: Input, STRING, waveform data type indicator. PROBES: Input, SCALAR STRING, name of THEMIS probe (i.e., only one probe -- 'a','b',...). Keywords: CAL_PARS: Output, STRUCT, see Notes below for elements. /TEST: Input, numeric, 0 or 1. Disables selected /CONTINUE to MESSAGE. For QA testing. Modifications: Added FILE_RETRIEVE() mechanism so that this routine can read the template and calibration files from the THEMIS local data directory. Also, added the "probes" parameter for the above purpose, W.M.Feuerstein, 2/27/2008. Changed "History" to "Modifications" in header, commented out all local calibration parameters, redifined ASCII template, now retrieving all calibration parameters from calibration files (these were expanded last Friday). Updated doc'n, WMF, 3/17/08. Implemented EAC/EDC gain conditional based on 1st element of TH?_EF?_HED_AC tplot variable, updated doc'n, WMF, 3/18/08. Inserted modern compile options, made ADC offsets integers in calibration files, updated read templates, WMF, 3/20/08. Fixed potential logical vs. bitwise conditional bug, updated calibration fields, WMF, 3/21/2008. Preparing for time-dependent calibration params. and AC/DC coupling gain conditional -- code still commented, WMF, 4/4/2008 (F). Replaced PRINT w/ MESSAGE for EAC/DC gain conditional warning. Added TEST kw (default = 0) to disable CONTINUE kw to selected MESSAGE commands. If a non-EFI datatype is passed then routine will stop, WMF, 4/7/2008 (M). Fixed typo "Defaulting to EAC gain"=>"...EDC...", rephrased, WMF, 4/9/2008 (W). Reformatted, WMF, 4/10/2008 (Th). Corrected an error to assigning the field gain to the output structure -- would only affect AC coupled data, WMF, 4/11/2008. Implemented time-dependent EAC/EDC gain conditional, WMF, 4/22/2008 (Tu). Removed "[0]" in some of the CP structure fields (moving to T-D calibration parameters), clipping CAL_PAR_TIME to TIMES, WMF, 4/23/2008 (W). Added 'efs' datatype to switch statement, WMF, 5/12/2008 (M). Stripped out time-dependent EAC/EDC gain conditional handling and moved to THM_CAL_EFI.PRO. Also, now passing EAC_GAIN and EDC_GAIN instead of just GAIN for the e?? datatype, WMF, 5/21 - 6/5/2008. Fixed crash on reading calibration files with only one line of data, WMF, 8/6/2008. Renamed from "thm_get_efi_cal_pars_td.pro" to "thm_get_efi_cal_pars.pro", WMF, 9/9/2008. Notes: -- use of TBEG and TEND for time-dependent calibration parameters is not currently implemented! -- Difference in gain between DC and AC coupled E-field data implemented, but not calibrated yet (as of 6/18/2009)! -- Elements of CAL_PARS are picked and chosen from the pertinent calibration file depending on NAME. See switch statement in code. $LastChangedBy: michf $ $LastChangedDate: 2008-05-15 11:17:41 -0700 (Thu, 15 May 2008) $ $LastChangedRevision: 3095 $ $URL $

Parameters

times
name
probes

Keywords

cal_pars
test

File attributes

Modification date: Thu Feb 13 16:42:39 2014
Lines: 120