Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

projects/themis/spacecraft/fields/LASP/

thm_efi_clean_efw.pro


Routines

top source thm_efi_clean_efw

thm_efi_clean_efw, probe=probe, Ename=Ename, Bdslname=Bdslname, trange=trange, talk=talk, EfpName=EfpName, FPole=FPole, Edslname=Edslname, Efacname=Efacname, SpikeRemove=SpikeRemove, SpikeNwin=SpikeNwin, SpikeSig=SpikeSig, SpikeSigmin=SpikeSigmin, SpikeNfit=SpikeNfit, SpikeFit=SpikeFit, diagnose=diagnose, wt=wt, status=status

PRO: THM_EFI_CLEAN_EFW PURPOSE: FIXES HF, REMOVES SPIKES, AND LOW FREQUENCY. This routine is designed for general use. It will take EFW data in DSL as input, clean up the data, and transform the data into FAC, and return the cleaned EFP data in DSL/FAC. The routine can work on one-day long data, but if only a single particle burst data is interesting, use the keyword TRANGE to specify the time range of that burst can greatly reduce run time. NOTE: 1) Spike removal does not always work, so don't be surprised if there still are spikes left on the data. Hopefully the spike issue can be resolved in the future. 2) Make sure thx_state_spinper is available! Best to set up for gsm. Make sure timespan is set!!!! EXAMPLES: For typical use, see thm_crib_cleanefw.pro and thm_crib_cleanefi.pro which are typically located under TDAS_DIR/idl/themis/examples. INPUT: KEYWORDS (general): probe NEEDED: Program does only one sc at a time! Ename OPTIONAL: Valid TPLOT name for E WAVE, DEFAULT = 'thX_efw' (will fetch) Bdslname OPTIONAL, Valid TPLOT name for B, DEFAULT = 'thX_fgh_dsl' (will fetch) trange OPTIONAL. Time range. USE TRANGE TO ISOLATE SINGLE PARTICLE BURST AND GREATLY REDUCE RUN TIME!!!! talk OPTIONAL. Plots diagnostics. Can be fun. Slow. DEFAULT = 0 EfpName OPTIONAL: Valid TPLOT name for EFP, DEFAULT = 'thX_efp' (will fetch) EFP is used to find spike positions. status OPTIONAL: A named variable to return the exiting status. If exit successfully, status = 0, otherwise status = 1 KEYWORDS (Filter): FPole (OBSOLETE) Kept for backward compatibility. KEYWORDS (for output tplot variables): Edslname OPTIONAL: Name for the cleaned efp in DSL. DEFAULT = Ename + '_clean_dsl' Efacname OPTIONAL: Name for the cleaned efp in DSL. DEFAULT = Ename + '_clean_fac' KEYWORDS (Remove_Spikes): SpikeRemove If entered as 0, suppresses spike removal. DEFAULT = 1 (Spikes are removed.) SpikeNwin Number of points in spike search window. DFLT = 16 SpikeSig Sigma of spikes. DFLT = 5 (Sometimes Sig = 6 works better) SpikeSigmin Minimun of sigma. DFLT = 0.01 mV/m. (Sometimes Sigmin = 0 works better) SpikeNfit Number of points in the fit window. DFLT = 16 SpikeFit If set, will do a Gaussian fit to Spikes. DFLT = 0 HISTORY: 2009-05-06: REE. First Release. 2009-06-04: Jianbao Tao (JBT), CU/LASP. The metadata (dlim.data_att) is modified properly. 2009-06-17: JBT, CU/LASP. Keyword STATUS added. 2010-04-08: JBT, CU/LASP. The high-pass filter is changed from an FFT filter to an FIR filter. Some modification is made to be compatible with two different sample rates 8192 Hz and 16384 Hz. 2010-09-13: JBT, CU/LASP. Cleaned up documents. Added keyword dt in calling thm_efi_fix_freq_and_phase. 2012-07-26: JBT, SSL, UC Berkeley. 1. Incorporated C. Cully's calibration for 1) Plasma-probe coupling 2) Anti-aliasing Bessel filter 3) ADC response 4) DFB response 2012-08-30: CMC, University of Calgary. Fixed problems with AC-coupled data sampled at < 16 ksps VERSION: $LastChangedBy$ $LastChangedDate$ $LastChangedRevision$ $URL$

Keywords

probe
Ename
Bdslname
trange
talk
EfpName
FPole
Edslname
Efacname
SpikeRemove
SpikeNwin
SpikeSig
SpikeSigmin
SpikeNfit
SpikeFit
diagnose
wt
status

File attributes

Modification date: Thu Feb 13 16:42:36 2014
Lines: 283