Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

projects/themis/spacecraft/particles/ESA/packet/functions/

thm_get_en_spec.pro


PROCEDURE: thm_get_en_spec PURPOSE: Generates energy-time spectrogram data structures for tplot INPUT: get_dat, a string that defines the 'routine' that returns a 2D or 3D data structure if 'probe' keyword set, assumes routine = get_dat if 'probe' keyword is not set, assumes routine = 'get_'+ get_dat unless get_dat already includes 'get_', in which case routine = get_dat for example, get_dat='thc_peir' then routine = 'get_thc_peir' for example, get_dat='thm_sst_pser' then routine = 'thm_sst_pser' KEYWORDS: T1: start time, seconds since 1970 T2: end time, seconds since 1970 ANGLE: fltarr(2),fltarr(4) angle range to sum over ARANGE: intarr(2) bin range to sum over BINS: bytarr(dat.nbins) bins to sum over gap_time: time gap big enough to signify a data gap (default 200 sec, 8 sec for FAST) NO_DATA: returns 1 if no_data else returns 0 UNITS: convert to these units if included NAME: New name of the Data Quantity, default = get_dat + '_en_spec' BKG: A 3d data structure containing the background counts If bkg=1, it will run themis background subtraction routine FLOOR: Sets the minimum value of any data point to sqrt(bkg). MISSING: value for bad data. RETRACE: Set to number of retrace energy steps to be eliminated starting at energy step 0 CALIB: Calib keyword passed on to get_dat -- no longer used PROBE: probe keyword passed on to get_dat -- used by themis sst routines CREATED BY: J.McFadden VERSION: 1 LAST MODIFICATION: 97/03/04 MOD HISTORY: 97/03/04 T1,T2 keywords added 97/05/22 CALIB keyword added 08/07/10 bkg keyword changed to work for Themis ion ESA 08/07/10 averaging routine changed to weight different angle bins by dat.gf 08/12/31 bkg keyword changed to work for Themis electron sst 08/12/31 probe keyword added for themis sst routines 09/01/05 changed loop to use index to allow for dat.valid=0 data in stored data 09/01/05 calib keyword no longer passed to routine 09/04/16 bkg keyword removed for Themis electron sst, assume bkg removal is part of get_th?_pse? 2014/06/30 Adding thm prefix to differentiate from identically named FAST routines NOTES: Current version only works for FAST and THEMIS

Routines

top source thm_get_en_spec

thm_get_en_spec, get_dat, T1=T1, T2=T2, ANGLE=ANGLE, ARANGE=ARANGE, BINS=BINS, gap_time=gap_time, no_data=no_data, units=units, name=name, bkg=bkg, missing=missing, floor=floor, retrace=retrace, CALIB=CALIB, probe=probe, _extra=_extra

Parameters

get_dat

Keywords

T1
T2
ANGLE
ARANGE
BINS
gap_time
no_data
units
name
bkg
missing
floor
retrace
CALIB
probe
_extra

File attributes

Modification date: Tue Oct 21 13:53:36 2014
Lines: 179