Changeset 9614 for trunk/psModules/src/detrend/pmFlatNormalize.c

Timestamp:

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

Author:

Paul Price

Message:

Documenting pmFlatNormalize

File:

• trunk/psModules/src/detrend/pmFlatNormalize.c (modified) (1 diff)

trunk/psModules/src/detrend/pmFlatNormalize.c

@@ -13 +13 @@
 // few with absolutely no trouble (it *is* over-constrained).  For this reason, I'm putting the maximum number
 // of iterations and tolerance as preset values.
-#define MAXITER 10
-#define TOLERANCE 1e-3
+#define MAXITER 10                      // Maximum number of iterations
+#define TOLERANCE 1e-3                  // Minimum tolerance for convergance
 
-// Estimate the flat-field normalisation; return the source flux in each integration
-bool pmFlatNormalize(psVector **expFluxesPtr, // Flux in each exposure; modified for return
-                     psVector **chipGainsPtr, // Initial guess of the chip gains; modified for return
-                     const psImage *bgMatrix
-                    )
+
+bool pmFlatNormalize(psVector **expFluxesPtr, psVector **chipGainsPtr, const psImage *bgMatrix)
 {
     PS_ASSERT_PTR_NON_NULL(bgMatrix, false);