Changeset 9612 for trunk/psModules/src/detrend/pmFlatField.h

Timestamp:

Oct 17, 2006, 10:38:42 AM (20 years ago)

Author:

Paul Price

Message:

Documenting pmFlatField.h. Fixing pmFlatField so that the image offsets are actually applied when flat-fielding.

File:

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

trunk/psModules/src/detrend/pmFlatField.h

@@ +1 @@
+/// @file pmFlatField.h
+///
+/// @brief Apply flat field calibration
+///
+/// @ingroup Detrend
+///
+/// @author Ross Harman, MHPCC
+/// @author Paul Price, IfA
+///
+/// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 20:38:42 $
+///
+/// Copyright 2004-2006 Institute for Astronomy, University of Hawaii
+///
+
 /** @file  pmFlatField.h
  *
@@ -18 +33 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-06-02 00:55:23 $
+ *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-10-17 20:38:42 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
  */
 
-#include "pslib.h"
+
+
 #include "pmFPA.h"
 
@@ -35 +51 @@
  *  @return  bool: True or false for success or failure
  */
-bool pmFlatField(
-    pmReadout *in,          ///< Readout with input image
-    const pmReadout *flat   ///< Readout with flat image
-);
 
+
+/// Apply flat field calibration to a readout
+///
+/// This function applies the flat field calibration to the input readout.  Support is available for different
+/// image types, though the input and flat images must have the same type.  The relative offsets between the
+/// input and flat images is determined from the readout row0,col0 and the CELL.X0 and CELL.Y0 concepts.
+/// Normalisation of the flat is left as the responsibility of the caller.  Negative pixels in the flat are
+/// masked, if there is a mask present in the input readout.
+bool pmFlatField(pmReadout *in,         ///< Readout with input image
+                 const pmReadout *flat  ///< Readout with flat image
+                );
+