Directory: general/missions/fast/fa_esa/functions/

Contents

.pro files

angle_to_bins.pro

FUNCTION: angle_to_bins(dat,an,EBIN=ebin)INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc.

cold_peak_2d.pro

FUNCTION: cold_peak_2d(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.

contour2d.pro

PROCEDURE: contour2d,dataPURPOSE: Produces contour plots of pitch angle dist.s from 2D data structures.

e_sec_eff.pro

FUNCTION: e_sec_eff(Te)INPUT: Te: flt,fltarr electron temperatureKEYWORDS pot flt,fltarr if fltarr, then n_elements(pot)=n_elements(te), default pot=0 tmax flt algorithm parameter, default tmax = 2.283 aa flt algorithm parameter, default aa = 1.35 emax flt algorithm parameter, default emax = 325 kk flt algorithm parameter, default kk = 2.2 sec_max flt algorithm parameter, default sec_max=2.

ec_2d_new.pro

FUNCTION: ec_2d_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.

energy_to_ebin.pro

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

fu_fit2d.pro

FUNCTION: fu_fit2d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,...) Select energy/angle range and perform functional fit to data (default Maxwellian)INPUTS: dat - data structure containing 2d data - e.g.

fu_spec2d.pro

PROGRAM: fu_spec2d,funct,datINPUT: funct: string, function that operates on structures generated by get_eesa_surv, get_eesa_burst, etc.

funct_fit2d.pro

PROCEDURE: funct_fit2d,dat Select energy/angle range and perform functional fit to data (default Maxwellian)INPUTS: dat - data structure containing 2d data - e.g.

get_2dt.pro

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

get_en_spec.pro

PROCEDURE: 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).

get_pa_spec.pro

PROCEDURE: get_pa_specPURPOSE: Generates pitch angle vs.

get_sp_spec.pro

PROCEDURE: get_sp_specPURPOSE: Generates spin phase angle vs.

j_2d_new.pro

FUNCTION: j_2d_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_2d_new.pro

FUNCTION: je_2d_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_2d_new.pro

FUNCTION: jo_2d_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.

n_2d_new.pro

FUNCTION: n_2d_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.

omni2d.pro

FUNCTION: omni2dPURPOSE: Produces an energy or angle averaged data structure Summing is over pitch angle or energy, default is pitch angle summing.

p_2d_new.pro

FUNCTION: p_2d_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.

peak_2d.pro

FUNCTION: peak_2d(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.

pitch2d.pro

PROCEDURE: pitch2d,dataPURPOSE: Plots 2d data as pitch angle distributions.

spec2d.pro

PROCEDURE: spec2d,dataPURPOSE: Plots 2d data as energy spectra.

sum2d.pro

FUNCTION: sum2dPURPOSE: Takes two 2D structures and returns a single 2D structure whose data is the sum of the twoINPUTS: d1,d2 each must be 3D structures obtained from the get_?? routines e.g.

t_2d_new.pro

FUNCTION: t_2d_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.

v_2d_new.pro

FUNCTION: v_2d_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.