Changeset 9298 for trunk/psModules/src/detrend/pmShutterCorrection.h

Timestamp:

Oct 5, 2006, 10:48:56 AM (20 years ago)

Author:

Paul Price

Message:

Cleaning up code, adding error checks, adding const where appropriate.

File:

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

trunk/psModules/src/detrend/pmShutterCorrection.h

@@ -31 +31 @@
  * First, as T_o goes to a large value, s() approaches the value of f'(x,y).
  * Next, as T_o goes to a very small value, s() approaches the value of
- * f'(x,y)*dT(x,y)/dT(0,0).  Finally, when s() has the value of 
+ * f'(x,y)*dT(x,y)/dT(0,0).  Finally, when s() has the value of
  * f'(x,y)*(1 + dT(x,y)/dT(0,0))/2, T_o has the value of dT(0,0).  with data
  * points covering a reasonable dynamic range, we can solve for these three
- * values by interpolation and/or extrapolation.  
+ * values by interpolation and/or extrapolation.
  
  * To take the strategy one step further, we could use the above recipe to
@@ -48 +48 @@
  *  @author Eugene Magnier, IfA
  *
- *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-09-25 01:06:28 $
+ *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-10-05 20:48:56 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -56 +56 @@
 #include "pslib.h"
 
+// Shutter correction parameters, applicable for a single pixel
 typedef struct
 {
-    double scale;     // A(k)
-    double offset;   // dTk
-    double offref;   // dTo
+    double scale;                       // The normalisation for an exposure, A(k)
+    double offset;                      // The time offset, dTk
+    double offref;                      // The reference time offset, dTo
 }
-pmShutterCorrPars;
+pmShutterCorrection;
 
-pmShutterCorrPars *pmShutterCorrParsAlloc ();
-pmShutterCorrPars *pmShutterCorrectionGuess (psVector *exptime, psVector *counts);
-pmShutterCorrPars *pmShutterCorrectionLinFit (psVector *exptime, psVector *counts, psVector *cntError, float offref);
-pmShutterCorrPars *pmShutterCorrectionFullFit (psVector *exptime, psVector *counts, psVector *cntError, pmShutterCorrPars *guess);
+// Allocator
+pmShutterCorrection *pmShutterCorrectionAlloc();
+
+// Guess a shutter correction, based on plot of counts vs exposure time.
+// Used before doing the full non-linear fit, to get parameters close to the true.
+// Assumes exptime vector is sorted (ascending order; longest is last) prior to input.
+pmShutterCorrection *pmShutterCorrectionGuess(const psVector *exptime, // Exposure times for each exposure
+        const psVector *counts // Counts for each exposure
+                                             );
+
+// Generate shutter correction based on a linear fit
+pmShutterCorrection *pmShutterCorrectionLinFit(const psVector *exptime, // Exposure times for each exposure
+        const psVector *counts, // Counts for each exposure
+        const psVector *cntError, // Error in the counts, for each exp.
+        float offref // Reference time offset
+                                              );
+
+// Generate shutter correction based on a full non-linear fit
+pmShutterCorrection *pmShutterCorrectionFullFit(const psVector *exptime, // Exposure times for each exposure
+        const psVector *counts, // Counts for each exposure
+        const psVector *cntError, // Error in the counts, for each exp
+        const pmShutterCorrection *guess // Initial guess
+                                               );