projects/themis/spacecraft/particles/
thm_part_combine.pro
*** WARNING: This routine is still in testing *** Procedure: thm_part_combine.pro Purpose: Create combined particle distribution from ESA and SST data. This distributions acts as a new data type and can be passed to all particle product code to create combined ESA/SST plots. Calling Sequence: combined_dist = thm_part_combine(probe=probe, trange=trange, esa_datatype=esa_datatype, sst_datatype=sst_datatype [,units=units] [,regrid=regrid] [,energies=energies] [,orig_esa=orig_esa] [,orig_sst=orig_sst]) Inputs: probe: Probe designation (string). trange: Two element array specifying time range (string or double). esa_datatype: ESA datatype designation (string). sst_datatype: SST datatype designation (string). units: String specifying output units ('flux', 'eflux', or 'df') regrid: Two element array specifying the number of points used to regrid the data in phi and theta respectively (int or float). energies: Array specifying the energies used to replace the default SST energies and cover the ESA-SST energy gap (in ascending order) (float). sst_sun_bins: Array list of SST bins to mask (bin indices) (int). only_sst: Interpolates ESA to match SST and returns SST(only) with interpolated bins.(Backwards compatibility: functionality of thm_sst_load_calibrate) interp_to_esa: Combined product but data interpolated to match ESA(instead of always interpolating to higher resolution) interp_to_sst: Combined product but data interpolated to match SST(instead of always interpolating to higher resolution) Outputs: combined_dist: Pointer array to combined distribution data. This is analagous to the arrays returned by thm_part_dist_array with each element referencing a distinct mode, or in this case combination of modes. orig_esa: Pointer array to original ESA distribution data. orig_sst: Pointer array to original SST distribution data. General Notes: Combined distributions can be used with the following routines in the same way as output from thm_part_dist_array: thm_part_products thm_part_slice2d thm_part_conv_units (unit conversion) thm_part_moments (wrapper/deprecated) thm_part_getspec (wrapper/deprecated) Processing more than 1-2 hours of data (full) at once may cause older systems to run out of memory. Typical run times 30-60+ sec. SST: This routine automatically uses the /sst_cal option when loading sst full or burst data and sets default contamination removal options. Reduced data will no calibrations or contamination removal applied. Other contamination options may be passed through to override the defaults, see SST contamination removal crib for options. Developer Notes: In general this code makes the following assumptions about the particle data: -(ESA & SST) The dimensions of all fields will remain constant within a mode. -(ESA & SST) A single distribution's energy bins are constant across all look angles. -(ESA & SST) Energy bins may change within a mode (they probably never will but this is assumed for safety). -(ESA & SST) Look directions, while general constant within a mode, may change at any point due to eclipse corrections to phi values. All E/phi/theta items above are assumed for the bin widths as well. Greater uniformity will be assumed as data is replaced with interpolated versions. $LastChangedBy: pcruce $ $LastChangedDate: 2014-03-05 17:20:40 -0800 (Wed, 05 Mar 2014) $ $LastChangedRevision: 14508 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/particles/thm_part_combine.pro $
Routines
top source thm_part_combine
result = thm_part_combine(probe=probe, esa_datatype=esa_datatype, sst_datatype=sst_datatype, trange=trange, units=units, regrid=regrid, energies=energies, sst_sun_bins=sst_sun_bins, orig_esa=orig_esa, orig_sst=orig_sst, only_sst=only_sst, interp_to_esa=interp_to_esa, interp_to_sst=interp_to_sst, _extra=_extra)
Keywords
- probe
- esa_datatype
- sst_datatype
- trange
- units
- regrid
- energies
- sst_sun_bins
- orig_esa
- orig_sst
- only_sst
- interp_to_esa
- interp_to_sst
- _extra
File attributes
Modification date: | Thu Mar 13 16:35:37 2014 |
Lines: | 98 |