Changeset 17228 for trunk/psModules/src/detrend/pmMaskBadPixels.h

Timestamp:

Mar 28, 2008, 5:10:17 PM (18 years ago)

Author:

Paul Price

Message:

Merging pap_branch_080328 so we can use the modernised version of ppMerge.

File:

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

trunk/psModules/src/detrend/pmMaskBadPixels.h

@@ -5 +5 @@
  * @author Eugene Magnier, IfA
  *
- * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
- * @date $Date: 2007-12-24 21:10:28 $
+ * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2008-03-29 03:10:17 $
  * Copyright 2004 Institute for Astronomy, University of Hawaii
  */
@@ -15 +15 @@
 /// @addtogroup detrend Detrend Creation and Application
 /// @{
+
+#define PM_MASK_ANALYSIS_SUSPECT "MASK.SUSPECT" // Readout analysis metadata keyword for suspect image
+#define PM_MASK_ANALYSIS_NUM "MASK.NUM" // Readout analysis metadata keyword for number of inputs
+
 
 typedef enum {
@@ -47 +51 @@
 /// image is of type S32.  The relevant median and standard deviation must be supplied in the
 /// readout->analysis metadata as READOUT.MEDIAN, READOUT.STDEVe
-psImage *pmMaskFlagSuspectPixels(psImage *out, ///< Suspected bad pixels image, or NULL
-                                 const pmReadout *readout, ///< Readout to inspect
-                                 float rej, ///< Rejection threshold (standard deviations)
-                                 psMaskType maskVal ///< Mask value for statistics
-                                );
+bool pmMaskFlagSuspectPixels(pmReadout *output, ///< Output readout, optionally with suspect pixels image
+                             const pmReadout *readout, ///< Readout to inspect
+                             float median, ///< Image median
+                             float stdev, ///< Image standard deviation
+                             float rej, ///< Rejection threshold (standard deviations)
+                             psMaskType maskVal ///< Mask value for statistics
+    );
 
 /// Identify bad pixels from the suspect pixels image
 ///
-/// 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).  If "thresh" is negative, a Poisson is assumed.
-psImage *pmMaskIdentifyBadPixels(const psImage *suspects, ///< Accumulated suspect pixels image
-                                 psMaskType maskVal, ///< Value to set for bad pixels
-                                 int nTotal,
-                                 float thresh, ///< Threshold for bad pixel (standard deviations)
-                                 pmMaskIdentifyMode mode
-                                );
+/// Bad pixels are identified from the suspect pixels image (accumulated over a large number of images),
+/// according to the chosen mode.
+bool pmMaskIdentifyBadPixels(pmReadout *output, ///< Output readout, with suspect pixels imageOut
+                             psMaskType maskVal, ///< Value to set for bad pixels
+                             float thresh, ///< Threshold for bad pixel
+                             pmMaskIdentifyMode mode ///< Mode for identifying bad pixels
+    );
 /// @}
 #endif