Changeset 17692 for trunk/psModules/src/camera/pmFPAMaskWeight.h

Timestamp:

May 14, 2008, 5:25:10 PM (18 years ago)

Author:

Paul Price

Message:

Adding new function: pmReadoutMaskNonfinite

File:

• trunk/psModules/src/camera/pmFPAMaskWeight.h (modified) (2 diffs)

trunk/psModules/src/camera/pmFPAMaskWeight.h

@@ -5 +5 @@
  * @author Eugene Magnier, IfA
  *
- * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
- * @date $Date: 2008-03-31 22:39:06 $
+ * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2008-05-15 03:25:10 $
  * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
  */
@@ -106 +106 @@
     );
 
-
+/// Explicitly mask non-finite pixels
+///
+/// Since unmasked non-finite pixels can occur (e.g., by out-of-range in quantisation), it is sometimes
+/// necessary to mask them explicitly.  Non-finite pixels in the image or weight have their mask OR-ed with
+/// the provided value.
+bool pmReadoutMaskNonfinite(pmReadout *readout, ///< Readout to mask
+                            psMaskType maskVal ///< Mask value to give non-finite pixels
+    );
 
 /// @}