Changeset 17729 for trunk/psModules/src/imcombine/pmSubtractionMask.h

Timestamp:

May 16, 2008, 4:30:51 PM (18 years ago)

Author:

Paul Price

Message:

Add a function to set masked pixels to NAN. This appears to be important in image subtraction because subtraction can produce a bimodal image for which statistics fails; then the image can't be written out compressed because the statistics is essential for quantisation.

File:

• trunk/psModules/src/imcombine/pmSubtractionMask.h (modified) (1 diff)

trunk/psModules/src/imcombine/pmSubtractionMask.h

@@ -22 +22 @@
     );
 
+/// Apply the subtraction mask to an image and weight.
+///
+/// Unfortunately, image subtraction may result in a bi-modal image in masked areas, which can upset image
+/// statistics (very important for quantising images so that a product can be written out!).  This function
+/// sets masked areas to NAN in the image and weight.
+bool pmSubtractionMaskApply(psImage *image, ///< Image to which to apply mask
+                            psImage *weight, ///< Weight map to which to apply mask (or NULL)
+                            const psImage *mask, ///< Subtraction mask
+                            pmSubtractionMode mode ///< Subtraction mode
+    );
+
 
 #endif