Changeset 10023

Timestamp:

Nov 16, 2006, 2:50:39 PM (20 years ago)

Author:

Paul Price

Message:

Adding additional notes.

File:

• trunk/psModules/src/detrend/pmMaskBadPixels.h (modified) (3 diffs)

trunk/psModules/src/detrend/pmMaskBadPixels.h

@@ -8 +8 @@
 /// @author Eugene Magnier, IfA
 ///
-/// @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
-/// @date $Date: 2006-11-15 00:27:52 $
+/// @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-11-17 00:50:39 $
 ///
 /// Copyright 2004 Institute for Astronomy, University of Hawaii
@@ -35 +35 @@
 /// Find pixels outlying from the background, flagging suspect pixels
 ///
-/// Pixels more than "rej" standard deviations from the background level (in flat-fielded images) have the
-/// corresponding pixel in the "suspect pixels" image incremented.  After accumulating over a suitable sample
-/// of images, bad pixels should have a high value in the suspect pixels image, allowing them to be
-/// identified.  The suspect pixels image is of type S32.
+/// Pixels more than "rej" standard deviations from the background level (in flat-fielded,
+/// background-subtracted images) have the corresponding pixel in the "suspect pixels" image incremented.
+/// After accumulating over a suitable sample of images, bad pixels should have a high value in the suspect
+/// pixels image, allowing them to be identified.  The suspect pixels image is of type S32.
 psImage *pmMaskFlagSuspectPixels(psImage *out, ///< Suspected bad pixels image, or NULL
                                  const pmReadout *readout, ///< Readout to inspect
@@ -51 +51 @@
 /// Bad pixels are identified from the suspect pixels image (accumulated over a large number of images).
 /// Pixels marked as suspect in more than "thresh" standard deviations from the mean are identified as bad
-/// pixels (output image).
+/// pixels (output image).  If "thresh" is negative, it is interpreted as a (base 10) logarithm of the
+/// fraction by which the number of pixels marked that many times must drop compared to the number of pixels
+/// with zero.
 psImage *pmMaskIdentifyBadPixels(const psImage *suspects, ///< Accumulated suspect pixels image
                                  float thresh, ///< Threshold for bad pixel (standard deviations)