Directory: projects/themis/spacecraft/particles/

Contents

.pro files

data_cache.pro

This is an experimental routine.

thm_cal_mom.pro

Deprecated, 8-feb-2010,jmm

thm_cmb_clean_esa.pro

Procedure: thm_cmb_clean_sstPurpose: Runs standard ESA sanitation routine on data array.

thm_cmb_clean_sst.pro

Procedure: thm_cmb_clean_sstPurpose: Runs standard SST sanitation routine on data array.

thm_convert_cmb_units.pro

Procedure: thm_convert_cmb_units.proPurpose: Unit conversion routine for combined (ESA+SST) particle distributions.

thm_esa_specmom_calc.pro

thm_load_esa.pro

Procedure: THM_LOAD_ESAPurpose: Loads THEMIS ESA datakeywords: probe = Probe name.

thm_part_apply_eclipse.pro

PURPOSE: Apply eclipse corrections (when present) to 3D data structures.

thm_part_check_trange.pro

NAME: thm_part_check_trangePURPOSE: This routine checks the time ranges of the current ESA and SST data stored in the common blocks to determine if it covers a particular time range.

thm_part_checkbins.pro

Procedure: thm_part_checkbinsPurpose: Checks if two particle distribution structures have identical energy, phi, theta, and mass values.

thm_part_combine.pro

*** WARNING: This routine is still in testing ***Procedure: thm_part_combine.proPurpose: Create combined particle distribution from ESA and SST data.

thm_part_conv_units.pro

Procedure: thm_part_conv_unitsPurpose: Takes the distribution data structure from a call to thm_part_dist_array and calibrates it.

thm_part_copy.pro

Procedure: thm_part_copyPurpose: Performs deep copy on particle data that is returned by thm_part_dist_arrayArguments: Old: A particle data structure to be copied New: A variable name to which the particle data should be copiedKeywords: error=error: Set to named variable.

thm_part_decomp16.pro

thm_part_dist.pro

NAME: thm_part_distPURPOSE: wrapper function around the different routines called 'get_p???' used for ESA particle data and 'thm_sst_p???' routines that extract SST data.

thm_part_dist_array.pro

Procedure: thm_part_dist_arrayPurpose: 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.

thm_part_energy_interp.pro

PROCEDURE: thm_part_energy_interpolatePURPOSE: Interpolate particle data by energy between sst & esa distributions using a weighted curve fitting routine.

thm_part_energy_interpolate.pro

PROCEDURE: thm_part_energy_interpolatePURPOSE: Interpolate particle data by energy between sst & esa distributions using a weighted curve fitting routineINPUTS: dist_sst: SST particle distribution structure in flux dist_esa: ESA particle distribution structure in flux energies: The set of target energies to interpolated the SST to.

thm_part_get_config.pro

NAME: thm_part_get_config.proPURPOSE: Returns structure containing particle distribution attributes based on APID and config word.

thm_part_getanbins.pro

PROCEDURE: thm_part_getanbinsPURPOSE: Create 3 arrays used by THM_PART_MOMENTS2 to turn on/off energy/angle bins Generates a [number of energy channels]x[number of angle bins] array (en_an_bins), an array [number of angle bins]x1 array (an_bins), and an array [number of energy channels]x1 array (en_bins) of 1's and 0's used by THM_PART_MOMENTS2 to turn on/off energy and angle bins based on the theta/phi/pitch angles, energy ranges, and data types requested by the user in THM_PART_GETSPEC.

thm_part_getmodechange.pro

Purpose: Access particle data common blocks to determine where mode changes occure and how many samples are in each configuration.

thm_part_getspec.pro

PROCEDURE: thm_part_getspecPURPOSE: Generate spectra from particle data Provides different angular view and angle restriction options in spacecraft and fac coordsInputs: Argument descriptions inline below.

thm_part_merge_dists.pro

*** This routine is in development, do not use! ***Procedure: thm_part_merge_dists.proPurpose: Merge ESA/SST particle distributions once they have been altered to match in time, energy, angle, and mode transition.

thm_part_omni_convert.pro

PROCEDURE: thm_part_omni_convertPURPOSE: Converts a particle distribution to omni directional by summing over angle.

thm_part_remove.pro

NAME: thm_part_remove.proPURPOSE: Remove bins that fall below a specified # of counts from any 3D particle data structure.

thm_part_smooth.pro

Procedure: thm_part_smoothPurpose: This routine applies time-smoothing to particle data using a convolution method.

thm_part_sphere_interp.pro

PROCEDURE: thm_part_sphere_interpPURPOSE: Temporary generalized copy of thm_part_sphere_interpolate (Interpolate particle data to match the look direcitons of another distribution)INPUTS: source: The particle distribution to be modified by spherical interpolation.

thm_part_sphere_interpolate.pro

PROCEDURE: thm_part_sphere_interpolatePURPOSE: Interpolate particle data to match the look direcitons of another distributionINPUTS: source: A particle dist_data structure to be modified by interpolation to match target target: A particle dist_data structure whose look directions will be matchedOUTPUTS: Replaces source with a spherically interpolated targetKEYWORDS: error: Set to 1 on error, zero otherwise NOTES: #1 Interpolation done using IDL library routine "griddata" #2 This code assumes that source & target have been time interpolated to match each other This has a ton of TBDs, we need to come back and fix them when time is available.

thm_part_subtract.pro

PROCEDURE: thm_part_subtractPURPOSE: Subtracts from a particle distribution down to a minimum.

thm_part_time_interpolate.pro

PROCEDURE: thm_part_time_interpolatePURPOSE: Interpolate particle data to match the time grid of another distribution, or to an arbitary time gridINPUTS: source: A particle dist_data structure to be modified by interpolation to match target target: A particle dist_data structure whose times will be matched, or an array of target times for interpolatuion.

thm_part_trange.pro

Procedure: thm_part_trangePurpose: Store/retrive the last requested time range for a particle data type.