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

Contents

.pro files

agyro_3d_new.pro

FUNCTION: agyro_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structure filled by, for example, get_th?_peef.proKEYWORDS 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,2), optional, angle range for integration theta min,max (0,0),(1,0) -90

beta_3d_new.pro

FUNCTION: beta_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structureKEYWORDS 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,2), optional, angle range for integration theta min,max (0,0),(1,0) -90

dj_3d_new.pro

FUNCTION: dj_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

dje_3d_new.pro

FUNCTION: dje_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structure filled by get_eesa_surv, get_eesa_burst, etc.

dm_3d_new.pro

FUNCTION: dm_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structure filled by themis routines get_th?_p???KEYWORDS 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,2), optional, angle range for integration theta min,max (0,0),(1,0) -90

dn_3d_new.pro

FUNCTION: dn_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

dp_3d_new.pro

FUNCTION: p_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

dv_3d_new.pro

FUNCTION: dv_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

ec_3d_new.pro

FUNCTION: ec_3d_new((dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

get_pa_spec3d.pro

PROCEDURE: get_pa_spec3dPURPOSE: Generates pitch angle vs.

j_3d_new.pro

FUNCTION: j_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

je_3d_new.pro

FUNCTION: je_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structure filled by get_eesa_surv, get_eesa_burst, etc.

je_par_3d_new.pro

FUNCTION: je_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structure filled by get_eesa_surv, get_eesa_burst, etc.

jeo_3d_new.pro

FUNCTION: jeo_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

jo_3d_new.pro

FUNCTION: jo_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

ld_3d_new.pro

FUNCTION: ld_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

m_3d_new.pro

FUNCTION: m_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structure filled by themis routines get_th?_p???KEYWORDS 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,2), optional, angle range for integration theta min,max (0,0),(1,0) -90

n_3d_new.pro

FUNCTION: n_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

p_3d_new.pro

FUNCTION: p_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

sst_atten.pro

FUNCTION: sst_atten(dat)INPUT: dat: structure, data structure filled by thm_sst_ps**KEYWORDS 0,1=exclude,includePURPOSE: Returns the attenuator value of the structureNOTES:CREATED BY: J.McFadden 09-01-06LAST MODIFICATION:

t_3d_new.pro

FUNCTION: t_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structure filled by get_eesa_surv, get_eesa_burst, etc.

thm_energy_to_ebin.pro

FUNCTION: thm_energy_to_ebin(dat,en)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

thm_get_2dt.pro

PROGRAM: thm_get_2dt,funct,get_datINPUT: funct: function, function that operates on structures generated by get_eesa_surv, get_eesa_burst, etc.

thm_get_en_spec.pro

PROCEDURE: thm_get_en_specPURPOSE: Generates energy-time spectrogram data structures for tplotINPUT: 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).

v_3d_new.pro

FUNCTION: v_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

vc_3d_new.pro

FUNCTION: vc_3d_new((dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

vpar_3d_new.pro

FUNCTION: vpar_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structureKEYWORDS 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,2), optional, angle range for integration theta min,max (0,0),(1,0) -90

vperp_3d_new.pro

FUNCTION: vperp_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structureKEYWORDS 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,2), optional, angle range for integration theta min,max (0,0),(1,0) -90

vxb_3d_new.pro

FUNCTION: vxb_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins)INPUT: dat: structure, 3d data structureKEYWORDS 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,2), optional, angle range for integration theta min,max (0,0),(1,0) -90