Changeset 4132 for trunk/psModules/src/pmSubtractBias.h

Timestamp:

Jun 7, 2005, 12:20:55 PM (21 years ago)

Author:

gusciora

Message:

Added doxygen comments.

File:

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

trunk/psModules/src/pmSubtractBias.h

@@ -4 +4 @@
  *  in place from an input image.
  *
- *  @author George Gusciora, MHPCC
+ *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-04-05 22:55:05 $
+ *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-07 22:20:55 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -37 +37 @@
 } pmFit;
 
-psReadout *pmSubtractBias(psReadout *in,
-                          void *fitSpec,
-                          const psList *overscans,
-                          pmOverscanAxis overScanAxis,
-                          psStats *stat,
-                          int nBin,
-                          pmFit fit,
-                          const psReadout *bias);
+psReadout *pmSubtractBias(psReadout *in,                ///< The input psReadout image
+                          void *fitSpec,                ///< A polynomial or spline, defining the fit type.
+                          const psList *overscans,      ///< A psList of overscan images
+                          pmOverscanAxis overScanAxis,  ///< Defines how overscans are applied
+                          psStats *stat,                ///< The statistic to be used in combining overscan data
+                          int nBin,                     ///< The amount of binning to be done image pixels.
+                          pmFit fit,                    ///< PM_FIT_SPLINE, PM_FIT_POLYNOMIAL, or PM_FIT_NONE
+                          const psReadout *bias);       ///< A possibly NULL bias psReadout which is to be subtracted
 
 #endif