Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

projects/themis/spacecraft/particles/SST/

thm_sst_find_masking.pro


PROCEDURE: THM_SST_FIND_MASKING Purpose: This routine is designed to find the indices of the masking in the SST Full distribution data. It directly checks the common block and then returns it for use by the remove_sunpulse routine While it is the function that actually takes the mask_fill argument, it should not ever be directly called by a user. It was written so that it can identify the mask locations efficiently using a total, prior to the point at which thm_part_moments and thm_part_moments2 begin to iterate over time. The majority of the documentation can be found in thm_remove_sunpulse.pro and thm_crib_sst_contamination.pro Arguments: thx: a string storing the satellite prefix(ie 'tha') instrument: a string identifying the instrument(ie 'psif') index: a list of indices which specify the times that were requested Keywords: mask_remove: Set this keyword to the proportion of values that must be 0 at all energies to determine that a mask is present. Generally .99 or 1.0 is a good value. The mask is a set of points that are set to 0 on-board the spacecraft. By default they will be filled by linear interpolation across phi. This keyword should be passed down via _extra from the parent routine. If this keyword is not set, this routine will always return -1. SEE ALSO: thm_part_moments.pro, thm_part_moments2.pro, thm_part_getspec.pro thm_part_dist.pro, thm_sst_psif.pro, thm_sst_psef.pro, thm_crib_sst_contamination.pro thm_sst_remove_sunpulse.pro $LastChangedBy: pcruce $ $LastChangedDate: 2013-01-10 16:45:16 -0800 (Thu, 10 Jan 2013) $ $LastChangedRevision: 11423 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/projects/themis/spacecraft/particles/SST/thm_sst_find_masking.pro $

Routines

top source thm_sst_find_masking

result = thm_sst_find_masking(thx, instrument, index, mask_remove=mask_remove, sst_cal=sst_cal)

Parameters

thx
instrument
index

Keywords

mask_remove
sst_cal

File attributes

Modification date: Thu Feb 13 16:42:42 2014
Lines: 52