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

Timestamp:

Oct 17, 2006, 12:17:38 PM (20 years ago)

Author:

Paul Price

Message:

Documenting and cleaning up pmMaskBadPixels; removing old error files --- unneccesary.

File:

• trunk/psModules/src/detrend/pmMaskBadPixels.h (modified) (1 diff)

trunk/psModules/src/detrend/pmMaskBadPixels.h

@@ -1 @@
-/** @file  pmMaskBadPixels.h
- *
- *  @brief Given an input image, a bad pixel mask, a corresponding value in the bad pixel mask to mask, a
- *  saturation level, and a growing radius, mask in the input image those pixels in the bad pixel mask that
- *  match the value to mask.
- *
- *  Given an input image, in, a bad pixel mask, a corresponding value in the bad pixel mask to mask in the
- *  input image, maskVal, a saturation level, and a growing radius, pmMaskBadPixels shall mask in the input
- *  image those pixels in the bad pixel mask that match the value to mask. Note that the input image, in, is
- *  modified in-place. All pixels in the mask which satisfy the maskVal shall have their corresponding pixels
- *  masked in the input image, in. All pixels which satisfy the growVal shall have their corresponding
- *  pixels, along with all pixels within the grow radius masked. Pixels which have flux greater than sat shall
- *  also be masked, but not grown. Note that the input image, in, and the mask 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 mask. In the event that the mask image is too small (i.e., pixels on the input image
- *  refer to pixels outside the range of the mask image), the function shall generate an error.
- *
- *  @author Ross Harman, MHPCC
- *
- *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-06-10 02:59:23 $
- *
- *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
- */
+/// @file pmMaskBadPixels.h
+///
+/// @brief Mask bad pixels
+///
+/// @ingroup Detrend
+///
+/// @author Ross Harman, MHPCC
+/// @author Eugene Magnier, IfA
+///
+/// @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 22:17:38 $
+///
+/// Copyright 2004 Institute for Astronomy, University of Hawaii
+///
+
 #ifndef PM_MASK_BAD_PIXELS_H
 #define PM_MASK_BAD_PIXELS_H
 
-#include "pslib.h"
+#include <pslib.h>
 #include "pmFPA.h"
 
-/** Execute bad pixels module.
- *
- *
- *  @return  bool: True or false for success or failure
- */
-
-bool pmMaskBadPixels(pmReadout *input, pmReadout *mask, psMaskType maskVal);
+/// Applies the bad pixel mask to the input
+///
+/// Pixels marked as bad within the mask are marked as bad within the input image's mask.  If maskVal is
+/// non-zero, all pixels in the mask have any of the same bits sets as maskVal shall have the corresponding
+/// bits raised.  If maskVal is zero, any zero pixels in the mask are OR-ed with PM_MASK_BAD.  Position
+/// offsets (such as due to trimming) between the input and mask are applied so that the same pixels are
+/// referred to.  The science readout must already have a supplied mask element (use eg. pmReadoutSetMask).
+/// The supplied mask image must be of MASK type
+bool pmMaskBadPixels(pmReadout *input,  ///< Input science image
+                     const pmReadout *mask, ///< Mask image to apply
+                     psMaskType maskVal ///< Mask value to apply
+                    );
 
 #endif