Directory: projects/maven/sta/mvn_sta_functions/

Contents

.pro files

c_4d.pro

FUNCTION: c_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

contour4d.pro

PROCEDURE: contour4d,dataPURPOSE: Produces contour plots of energy-mass distributions from 4D data structures.

dj_4d.pro

FUNCTION: dj_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

dn_4d.pro

FUNCTION: dn_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=mass,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

dv_4d.pro

FUNCTION: dv_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

ec_4d.pro

FUNCTION: ec_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

get_4dt.pro

PROGRAM: get_4dt,funct,routineINPUT: funct: function, function that operates on structures generated by mvn_sta_get_?? funct = 'n_4d','j_4d','v_4d','p_4d','t_4d', ...

j_4d.pro

FUNCTION: j_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

je_4d.pro

FUNCTION: je_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

m_4d.pro

FUNCTION: m_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

mvn_sta_c6_bkg.pro

FUNCTION: mvn_sta_c6_bkg(dat)INPUT: dat: structure, generated by mvn_sta_get_c6()KEYWORDSPURPOSE: Returns the background for maven static apid c6 structuresNOTES: Function to calculate the straggling backgroud from maven static apid c6 packets Function can be used as "bkg" keyword passed to get_4dt.pro for background subtraction This generates a decent, energy independent background subtraction if coincident events can be ignored proton straggling represents about ~2% of the events when coincident events can be ignoredCREATED BY: J.McFadden 14-05-08LAST MODIFICATION:

mvn_sta_convert_units.pro

mvn_sta_get.pro

PROCEDURE: mvn_sta_getPURPOSE: Returns static data structure for keyword selected APID averaged over a time rangeINPUT: apid: string apid of data to be returned 'c0','c2','c4','c6'...

mvn_sta_get_2a.pro

PROCEDURE: mvn_sta_get_2aPURPOSE: Returns APID 2a data structure at a single time from common generated by mvn_sta_hkp_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_c0.pro

PROCEDURE: mvn_sta_get_c0PURPOSE: Returns APID c0 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_c2.pro

PROCEDURE: mvn_sta_get_c2PURPOSE: Returns APID c2 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_c4.pro

PROCEDURE: mvn_sta_get_c4PURPOSE: Returns APID c4 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_c6.pro

PROCEDURE: mvn_sta_get_c6PURPOSE: Returns APID c6 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_c8.pro

PROCEDURE: mvn_sta_get_c8PURPOSE: Returns APID c8 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_ca.pro

PROCEDURE: mvn_sta_get_caPURPOSE: Returns APID ca data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_cc.pro

PROCEDURE: mvn_sta_get_ccPURPOSE: Returns APID cc data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_cd.pro

PROCEDURE: mvn_sta_get_cdPURPOSE: Returns APID cd data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_ce.pro

PROCEDURE: mvn_sta_get_cePURPOSE: Returns APID ce data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_cf.pro

PROCEDURE: mvn_sta_get_cfPURPOSE: Returns APID cf data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_d0.pro

PROCEDURE: mvn_sta_get_d0PURPOSE: Returns APID d0 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_d1.pro

PROCEDURE: mvn_sta_get_d1PURPOSE: Returns APID d1 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_d2.pro

PROCEDURE: mvn_sta_get_d2PURPOSE: Returns APID d2 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_d3.pro

PROCEDURE: mvn_sta_get_d3PURPOSE: Returns APID d3 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_d4.pro

PROCEDURE: mvn_sta_get_d4PURPOSE: Returns APID d4 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_d6.pro

PROCEDURE: mvn_sta_get_d6PURPOSE: Returns APID d6 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_d8.pro

PROCEDURE: mvn_sta_get_d8PURPOSE: Returns APID d8 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_d9.pro

PROCEDURE: mvn_sta_get_d9PURPOSE: Returns APID d9 data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_da.pro

PROCEDURE: mvn_sta_get_daPURPOSE: Returns APID da data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

mvn_sta_get_db.pro

PROCEDURE: mvn_sta_get_dbPURPOSE: Returns APID db data structure at a single time from common generated by mvn_sta_prod_cal.proINPUT: time: dbl time of data to be returnedKEYWORDS: start: 0,1 if set, gets first time in common block en: 0,1 if set, gets last time in common block advance 0,1 if set, gets next time in common block retreat 0,1 if set, gets previous time in common block index long gets data at the index value "ind" in common block calib: 0,1 not working yet, allows alternate calibration times 0,1 returns an array of times for all the data, returns 0 if no dataCREATED BY: J.

n_4d.pro

FUNCTION: n_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

nb_4d.pro

FUNCTION: nb_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

omni4d.pro

FUNCTION: omni4dPURPOSE: produces an omnidirectional spectrum structure by summing over the non-zero bins in the keyword bins.

p_4d.pro

FUNCTION: p_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q)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

spec4d.pro

PROCEDURE: spec4d,data Plots 3d data as energy spectra.

sum4d.pro

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

sum4m.pro

FUNCTION: sum4mPURPOSE: produces an omnidirectional spectrum structure by summing over the non-zero bins in the keyword bins.

t_4d.pro

FUNCTION: t_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

tb_4d.pro

FUNCTION: tb_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

tp_4d.pro

FUNCTION: tp_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

v_4d.pro

FUNCTION: v_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

vb_4d.pro

FUNCTION: vb_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

vc_4d.pro

FUNCTION: vc_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

vp_4d.pro

FUNCTION: vp_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.

wc_4d.pro

FUNCTION: wc_4d(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins,MASS=ms,m_int=mi,q=q,mincnt=mincnt)INPUT: dat: structure, 4d data structure filled by themis routines mvn_sta_c6.pro, mvn_sta_d0.pro, etc.