NAME: thm_part_dist PURPOSE: wrapper function around the different routines called 'get_p???' used for ESA particle data and 'thm_sst_p???' routines that extract SST data. INPUT: format = a string denoting the data that is desired: options are: 'tha_peif': Full Esa mode data, ions, probe A 'tha_peef': Full Esa mode data, electrons, probe A 'tha_peir': Reduced Esa mode data, ions, probe A 'tha_peer': Reduced Esa mode data, electrons, probe A 'tha_peir': Burst Esa mode data, ions, probe A 'tha_peer': Reduced Esa mode data, electrons, probe A 'tha_psif': Full Sst mode data, ions, probe A 'tha_psef': Full Sst mode data, electrons, probe A 'tha_psir': Reduced Sst mode data, ions, probe A 'tha_pser': Reduced Sst mode data, electrons, probe A For other probes, just replace 'tha' with the appropriate string, 'thb', 'thc', 'thd', 'the' If this is not set, then the string is constructed from the type and probe keywords time = an input time, if not passed in, then this routine will attempt to get the time from plotted data, via ctime, unless the index keyword is passed in (for SST) or when start, en, advance, retreat, or index are passed in. KEYWORDS: type = 4 character string denoting the type of data that you need, e.g., 'peif' for full mode esa data probe = the THEMIS probe, 'a','b','c','d','e' cursor = if set, then choose a time from the plot, using ctime.pro. This overrides any input -- that is, the variable that was used becomes the input variable and the time obtained becomes the time of the data. index = an index for the data point that is to be returned start (ESA only) = if set, then get the first saved data point en (ESA only) = if set, get the last saved data point advance (ESA only) = if set, get the data point after the one that was gotten last retreat (ESA only) = if set, get the data point before the one that was gotten last times = if set, returns the time array for all the saved data points OUTPUT: dat = the '3d data structure' for the given data type: In general this will be different for different data types, but there are elements that are common to all, Here is a sample for tha_psif data: PROJECT_NAME STRING 'THEMIS' DATA_NAME STRING 'SST Ion Full distribution' UNITS_NAME STRING 'Counts' UNITS_PROCEDURE STRING 'thm_sst_convert_units' TPLOTNAME STRING '' TIME DOUBLE 1.1837675e+09 END_TIME DOUBLE 1.1837676e+09 TRANGE DOUBLE Array[2] ;;not always present INDEX LONG 4 NBINS LONG 64 NENERGY LONG 16 MAGF FLOAT Array[3] SC_POT FLOAT 0.00000 MASS FLOAT 0.0104390 CHARGE FLOAT 0.00000 VALID INT 1 MODE INT 0 CNFG INT 577 NSPINS INT 64 DATA FLOAT Array[16, 64] ENERGY FLOAT Array[16, 64] THETA FLOAT Array[16, 64] PHI FLOAT Array[16, 64] DENERGY FLOAT Array[16, 64] DTHETA FLOAT Array[16, 64] DPHI FLOAT Array[16, 64] BINS INT Array[16, 64] GF FLOAT Array[16, 64] INTEG_T FLOAT Array[16, 64] DEADTIME FLOAT Array[16, 64] GEOM_FACTOR FLOAT 0.100000 ATTEN INT 10 NOTE: 1. that the .time tag refers to the interval start time. The .trange tag gives the time range, and is not always present. 2. For documentation on sun contamination correction keywords that may be passed in through the _extra keyword please see: thm_remove_sunpulse.pro or thm_crib_sst_contamination.pro $LastChangedBy: aaflores $ $LastChangedDate: 2014-05-09 14:11:06 -0700 (Fri, 09 May 2014) $ $LastChangedRevision: 15085 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/particles/thm_part_dist.pro $