This page was created by the IDL library routine
mk_html_help2
.
Last modified: Wed Apr 14 11:49:06 2010.
FUNCTION: beta_3d_new(dat,ENERGY=en,ERANGE=er,EBINS=ebins,ANGLE=an,ARANGE=ar,BINS=bins) INPUT: dat: structure, 3d data structure 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns beta, P/B^2/8pi, corrects for spacecraft potential if dat.sc_pot exists NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 07-4-29 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/beta_3d_new.pro)
FUNCTION: energy_to_ebin(dat,en) INPUT: dat: structure, 2d data structure filled by get_eesa_surv, get_eesa_burst, etc. en: real,fltarr, real or float array of energy values KEYWORD: BIN int,intarr optional, angle bins corresponding to "en" used when energies depend upon angle bin PURPOSE: Returns the energy bin numbers in "dat.energy" nearest to "en" CREATED BY: J.McFadden LAST MODIFICATION: 96-4-22 J.McFadden
(See themis/spacecraft/particles/ESA/packet/functions/energy_to_ebin.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 NOTES: Current version only works for FAST
(See themis/spacecraft/particles/ESA/packet/functions/get_2dt.pro)
PROCEDURE: get_en_spec PURPOSE: Generates energy-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 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). 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_dat -- no longer used PROBE: probe keyword passed on to get_dat -- used by themis sst routines CREATED BY: J.McFadden VERSION: 1 LAST MODIFICATION: 97/03/04 MOD HISTORY: 97/03/04 T1,T2 keywords added 97/05/22 CALIB keyword added 08/07/10 bkg keyword changed to work for Themis ion ESA 08/07/10 averaging routine changed to weight different angle bins by dat.gf 08/12/31 bkg keyword changed to work for Themis electron sst 08/12/31 probe keyword added for themis sst routines 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 NOTES: Current version only works for FAST and THEMIS
(See themis/spacecraft/particles/ESA/packet/functions/get_en_spec.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. 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns the energy flux, [JEx,JEy,JEz], 1/(cm^2-s) NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 02-9-13 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/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. 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns the energy flux, [JEx,JEy,JEz], 1/(cm^2-s) NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 02-9-13 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/je_par_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. 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns the flux, [Jx,Jy,Jz], 1/(cm^2-s) NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 00-2-24 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/j_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. 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns the density, n, 1/cm^3, corrects for spacecraft potential if dat.sc_pot exists NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 00-2-24 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/n_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. 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns the pressure tensor, [Pxx,Pyy,Pzz,Pxy,Pxz,Pyz], eV/cm^3 NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 00-2-24 LAST MODIFICATION: J.McFadden 05-2-8 Fixed diagonalization J.McFadden 06-2-23 changed the s/c pot calculation to the same as n_2d_new.pro
(See themis/spacecraft/particles/ESA/packet/functions/p_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. 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns the temperature, [Tx,Ty,Tz,Tavg], eV NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 00-2-24 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/t_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 structure 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns Vpar, km/s, corrects for spacecraft potential if dat.sc_pot exists NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 07-6-05 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/vpar_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 structure 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns Vperp, km/s, corrects for spacecraft potential if dat.sc_pot exists NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 07-6-05 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/vperp_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 structure 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns VxB, mV/m, corrects for spacecraft potential if dat.sc_pot exists NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 07-4-29 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/vxb_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. 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<theta<90 phi min,max (0,1),(1,1) 0<phi<360 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 0,1=exclude,include PURPOSE: Returns the velocity, [Vx,Vy,Vz], km/s NOTES: Function normally called by "get_3dt" or "get_2dt" to generate time series data for "tplot.pro". CREATED BY: J.McFadden 02-8-28 LAST MODIFICATION:
(See themis/spacecraft/particles/ESA/packet/functions/v_3d_new.pro)