Documentation for /home/davin/idl/socware/

Generated by IDLdoc

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

general/missions/fast/fa_esa/functions/

get_2dt.pro


PROGRAM: get_2dt,funct,get_dat INPUT: funct: function, function that operates on structures generated by get_eesa_surv, get_eesa_burst, etc. funct = 'n_2d','j_2d','v_2d','p_2d','t_2d', 'vth_2d','ec_2d', or 'je_2d' 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: real or dbl start time, seconds since 1970 T2: real or dbl end time, seconds since 1970 ENERGY: fltarr(2), optional, min,max energy range for integration ERANGE: fltarr(2), optional, min,max energy bin numbers for integration EBINS: bytarr(na), optional, energy bins array for integration 0,1=exclude,include, na = dat.nenergy ANGLE: fltarr(2), optional, min,max pitch angle range for integration ARANGE: fltarr(2), optional, min,max angle bin numbers for integration BINS: bytarr(nb), optional, angle bins array for integration 0,1=exclude,include, nb = dat.ntheta BINS: bytarr(na,nb), optional, energy/angle bins array for integration GAP_TIME: time gap big enough to signify a data gap (def 200 sec, 8 sec for FAST) NO_DATA: returns 1 if no_data else returns 0 NAME: New name of the Data Quantity Default: funct+'_'+get_dat 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. 0,1=exclude,include CALIB: Calib keyword passed on to get_dat -- no longer used PROBE: probe keyword passed on to get_dat -- used by themis sst routines PURPOSE: To generate time series data for "tplot.pro" NOTES: Program names time series data to funct+"_"+get_dat if NAME keyword not set See 'tplot_names.pro'. CREATED BY: J.McFadden LAST MODIFICATION: 97/03/04 MOD HISTORY: 97/03/04 T1,T2 keywords added 08/07/10 bkg keyword changed to work for Themis ion ESA 08/12/31 bkg keyword changed to work for Themis electron sst 08/12/31 added probe keyword for themis sst calls 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? NOTES: Current version only works for FAST

Routines

top source get_2dt

get_2dt, funct, get_dat, T1=T1, T2=T2, ENERGY=ENERGY, ERANGE=ERANGE, EBINS=EBINS, ANGLE=ANGLE, ARANGE=ARANGE, BINS=BINS, gap_time=gap_time, no_data=no_data, name=name, bkg=bkg, missing=missing, floor=floor, CALIB=CALIB, probe=probe

Parameters

funct
get_dat

Keywords

T1
T2
ENERGY
ERANGE
EBINS
ANGLE
ARANGE
BINS
gap_time
no_data
name
bkg
missing
floor
CALIB
probe

File attributes

Modification date: Thu Feb 13 16:43:29 2014
Lines: 108