Changeset 9617 for trunk/psModules/src/detrend/pmNonLinear.h

Timestamp:

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

Author:

Paul Price

Message:

Documenting pmNonLinear.h. Cleaning up pmNonLinear.c

File:

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

trunk/psModules/src/detrend/pmNonLinear.h

@@ -1 @@
-//////////////////////////////////////////////////////////////////////////////////////////////////////////////
-// XXX WARNING: I have completely replaced this file with an OLD VERSION (that works) instead of the
-// one that was being worked on.
-//////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/// @file pmNonLinear.h
+///
+/// @brief Perform non-linear correction through polynomial or table lookup
+///
+/// @ingroup Detrend
+///
+/// @author George Gusciora, MHPCC
+/// @author Paul Price, IfA
+///
+/// @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-17 22:57:27 $
+///
+/// Copyright 2004 Institute for Astronomy, University of Hawaii
+///
 
-/** @file  pmNonLinear.h
- *
- *  Provides polynomial or table lookup non-linearity corrections to readouts.
- *
- *  @author GLG, MHPCC
- *
- *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-04-17 18:01:05 $
- *
- *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
- *
- */
-
-#if !defined(PM_NON_LINEAR_H)
+#ifndef PM_NON_LINEAR_H
 #define PM_NON_LINEAR_H
 
-#include "pslib.h"
+#include <pslib.h>
 #include "pmFPA.h"
 
-pmReadout *pmNonLinearityPolynomial(pmReadout *in,
-                                    const psPolynomial1D *coeff);
+/// Correct non-linearity through polynomial
+///
+/// Applies a polynomial to the flux of each pixel in the input image to determine the corrected flux.
+pmReadout *pmNonLinearityPolynomial(pmReadout *in, ///< Input image, to correct
+                                    const psPolynomial1D *coeff ///< Polynomial for non-linearity correction
+                                   );
 
-pmReadout *pmNonLinearityLookup(pmReadout *in,
-                                const psVector *inFlux,
-                                const psVector *outFlux);
+/// Correct non-linearity through table lookup
+///
+/// For each pixel in the input image, performs linear interpolation on the table (from the two vectors) to
+/// determine the corrected flux.
+pmReadout *pmNonLinearityLookup(pmReadout *in, ///< Input image, to correct
+                                const psVector *inFlux, ///< Table column with input fluxes
+                                const psVector *outFlux ///< Table column with output fluxes
+                               );
 
 #endif