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/

get_pa_spec3d.pro


PROCEDURE: get_pa_spec3d PURPOSE: Generates pitch angle vs. 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 ENERGY: fltarr(2) energy range to sum over ERANGE: intarr(2) energy bin range to sum over EBINS: bytarr(dat.nenergy) energy 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 BKG: A 3d data structure containing the background counts. 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_"get_dat"_ts EWEIGHT Weights the energy bin average by bin energy width. SHIFT90 If set true, pitch angle range is -90 to 270 CREATED BY: J.McFadden 08-07-07 VERSION: 1 LAST MODIFICATION: 09-01- MOD HISTORY: 09-01-08 bkg keyword changed to work for Themis electron sst 09-01-08 probe keyword added for themis sst routines 09-01-08 changed loop to use index to allow for dat.valid=0 data in stored data 09-01-08 calib keyword no longer passed to routine NOTES: Modified from get_pa_spec.pro used for 2-D data structures for FAST or Cluster/PEACE get_pa_spec3d.pro converts 3-D data structures two 2D pitch angle data

Routines

top source get_pa_spec3d

get_pa_spec3d, get_dat, T1=T1, T2=T2, ENERGY=ENERGY, ERANGE=ERANGE, EBINS=EBINS, gap_time=gap_time, no_data=no_data, units=units, name=name, bkg=bkg, missing=missing, floor=floor, retrace=retrace, CALIB=CALIB, eweight=eweight, shift90=shift90, _extra=_extra

Parameters

get_dat

Keywords

T1
T2
ENERGY
ERANGE
EBINS
gap_time
no_data
units
name
bkg
missing
floor
retrace
CALIB
eweight
shift90
_extra

File attributes

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