projects/themis/spacecraft/particles/
thm_part_dist_array.pro
Procedure: thm_part_dist_array Purpose: Returns an array of pointers to ESA or SST particle distributions.(One pointer for new mode in the time series) This routine is a wrapper for thm_part_dist, which returns single distributions. Required Keywords: PROBE: The THEMIS probe, 'a','b','c','d','e'. DATATYPE: Four character string denoting the type of data that you need. ESA Ions (full/reduced/burst) 'peif' - Full mode 'peir' - Reduced mode 'peib' - Burst mode ESA Electrons 'peef' - Full 'peer' - Reduced 'peeb' - Burst SST Ions 'psif' - Full 'psir' - Reduced SST Electrons 'psef' - Full 'pser' - Reduced 'pseb' - Burst TRANGE: Time range of interest (2 element array, string or numerical). *This keyword may be ommitted if 'timespan is set. If neither TRANGE nor 'timespan' is set the user will be prompted. Optional Keywords: MAG_DATA: Tplot variable containing magnetic field data. The data will be interpolated to the cadence of the requested particle distribution and added to the returned structures under the tag 'MAGF'. VEL_DATA: Tplot variable containing velocity data. The data will be interpolated to the cadence of the requested particle distribution and added to the returned structures under the tag 'VELOCITY'. If not set V_3D_NEW.PRO will be used instead. GET_SUN_DIRECTION: Adds sun direction vector to the returned structures under the tag 'SUN_VECTOR' FRACTIONAL_COUNTS: Flag to keep the ESA unit conversion routine from rounding to an even number of counts when removing the dead time correction (no effect if input data already in counts, no effect on SST data). This will only be used by this code when calculating the bulk velocity with V_3D_NEW.PRO ESA Keywords: BGND_REMOVE: Flag to turn on ESA background removal. BGND_TYPE: String naming removal type, e.g. 'angle','omni', or 'anode'. BGND_NPOINTS: Number of lowest values points to average over when determining background. BGND_SCALE: Scaling factor that the background will be multiplied by before it is subtracted. SST Keywords: SST_CAL: Flag to use newest SST calibrations Examples: dist_array = thm_part_dist_array(probe='b',datatype='pseb', $ trange='2008-2-26/04:'+['50:00','55:00']) timespan, '2008-2-26/04:50:00', 5, /min dist_array = thm_part_dist_array(probe='b',datatype='psif', $ vel_data='tplot_vel', $ mag_data='tplot_mag') See Also: thm_crib_part_product, thm_part_products thm_crib_part_slice2d, thm_part_slice2d thm_crib_esa_bgnd_remove, thm_esa_bgnd_remove, Created by Bryan Kerr Modified by A. Flores $LastChangedBy: aaflores $ $LastChangedDate: 2014-02-24 18:05:51 -0800 (Mon, 24 Feb 2014) $ $LastChangedRevision: 14423 $ $URL $
Routines
Routines from thm_part_dist_array.pro
result = thm_part_dist_array_getsun(probe=probe, times=times, fail=fail)
Purpose: Find the sun direcion vector if requested
result = thm_part_dist_array(format=format, trange=trange, type=type, datatype=datatype, probe=probe, mag_data=mag_data, vel_data=vel_data, get_sun_direction=get_sun_direction, suffix=suffix, err_msg=err_msg, forceload=forceload, gettimes=gettimes, sst_cal=sst_cal, _extra=_extra)
Routine details
top source thm_part_dist_array_getsun
result = thm_part_dist_array_getsun(probe=probe, times=times, fail=fail)
Purpose: Find the sun direcion vector if requested
Keywords
- probe
- times
- fail
top source thm_part_dist_array
result = thm_part_dist_array(format=format, trange=trange, type=type, datatype=datatype, probe=probe, mag_data=mag_data, vel_data=vel_data, get_sun_direction=get_sun_direction, suffix=suffix, err_msg=err_msg, forceload=forceload, gettimes=gettimes, sst_cal=sst_cal, _extra=_extra)
Keywords
- format
- trange
- type
- datatype
- probe
- mag_data
- vel_data
- get_sun_direction
- suffix
- err_msg
- forceload
- gettimes
- sst_cal
- _extra
File attributes
Modification date: | Thu Mar 13 16:35:37 2014 |
Lines: | 155 |