Changeset 1822 for trunk/psModules/src/pmFlatField.h

Timestamp:

Sep 16, 2004, 2:49:04 PM (22 years ago)

Author:

harman

Message:

Updated per conversations with Robert DeSonia and Paul Price

File:

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

trunk/psModules/src/pmFlatField.h

@@ -1 +1 @@
 /** @file  pmFlatField.h
  *
- *  @brief Given an input image and a flat-field image, pmFlatField shall divide the input image by the flat-field image.
+ *  @brief Given an input image and a flat field image, pmFlatField shall divide the input image by the flat
+ *  field image.
  *
- *  The input image, in, and the flat-field image, flat, need not be the same size, since the input image may already have
- *  been trimmed (following overscan subtraction), but the function shall use the offsets in the image (in->x0
- *  and in->y0) to determine the appropriate offsets to obtain the correct pixel on the flat-field. In the event that the flat
- *  image is too small (i.e., pixels on the input image refer to pixels outside the range of the flat image), the function shall
- *  generate an error. Pixels which are negative or zero in the flat shall be masked in the input image with the value PM_MASK_FLAT
- *  Negative pixels in the flat may be set to zero so that they are treated identically to zeroes. Any pixels masked in the flat
- *  shall be masked with corresponding values in the output. The function shall not normalize the flat; this responsibility is
- *  left to the caller. This function is basically equivalent to a divide (with psImageOp), but with care for the region that is
- *  divided, checking for negative pixels, and copying of the mask from the flat to the output.
+ *  The input image, in, and the flat field image, flat, need not be the same size, since the input image may
+ *  already have been trimmed (following overscan subtraction), but the function shall use the offsets in the
+ *  image (in->x0 and in->y0) to determine the appropriate offsets to obtain the correct pixel on the flat
+ *  field. In the event that the flat image is too small (i.e., pixels on the input image refer to pixels
+ *  outside the range of the flat image), the function shall generate an error. Pixels which are negative or
+ *  zero in the flat shall be masked in the input image with the value PM_MASK_FLAT. Negative pixels in the
+ *  flat may be set to zero so that they are treated identically to zeroes. Any pixels masked in the flat
+ *  shall be masked with corresponding values in the output. The function shall not normalize the flat; this
+ *  responsibility is left to the caller. This function is basically equivalent to a divide (with psImageOp),
+ *  but with care for the region that is divided, checking for negative pixels, and copying of the mask from
+ *  the flat to the output.
  *
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-09-15 01:04:50 $
+ *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-09-17 00:49:04 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -23 +26 @@
 #include "pslib.h"
 
-/** Mask values */
-typedef enum {
-    PM_MASK_TRAP    = 0x0001,   ///< The pixel is a charge trap
-    PM_MASK_BADCOL  = 0x0002,   ///< The pixel is a bad column
-    PM_MASK_SAT     = 0x0004,   ///< The pixel is saturated
-    PM_MASK_FLAT    = 0x0008    ///< The pixel is non-positive in the flat-field
-} pmMaskValue;
+/** Execute flat field module.
+ *
+ *  Given an input image and a flat-field image, pmFlatField shall divide the input image by the flat field
+ *  image.
+ *
+ *  @return  bool: True or false for success or failure
+ */
+bool pmFlatField(
+    psReadout *in,          ///< Redout with input image and mask
+    const psReadout *flat   ///< Readout with flat image
+);
 
-bool pmFlatField(psReadout *in, psReadout *inMask, const psReadout *flat);
-