Changeset 9618 for trunk/psModules/src/detrend/pmShutterCorrection.c

Timestamp:

Oct 17, 2006, 2:47:15 PM (20 years ago)

Author:

Paul Price

Message:

Documenting pmShutterCorrection.[ch]

File:

• trunk/psModules/src/detrend/pmShutterCorrection.c (modified) (5 diffs)

trunk/psModules/src/detrend/pmShutterCorrection.c

@@ -1 @@
-/*
- * measure shutter correction:
- 
- * input  : collection of shutter correction exposures (pre-processed)
- * output : a shutter correction image
- 
- * the measurement could be performed on any focal-plane unit at a time. for
- * GPC, the obvious scale is to measure the effect on the entire focal plane at
- * once, with a single reference point in the field.  this is a little more
- * complex than just measuring the effect for a single 2D image array.  the
- * reference point and the detailed analysis points need to be defined for the
- * entire hierarchy rather than just as coordinate pairs or regions.  a
- * pmFPAview would be a natural element with which to define these points, but
- * at the moment, the pmFPAview structure defines a band in the CCD, not a
- * coordinate.  An option is to instead specify the reference locations as a
- * pmFPAview coupled with a psRegion, though we need to be careful not to
- * over-specify the pixels (ie, conflict between pmFPAview and psRegion).
- 
- * at each point in an image with exposure time T, we measure f(k;T) = F(k;T) /
- * F(0;T) where k is the coordinate of the point of interest, 0 is the reference
- * coordinate, and F(k;T) is the measured number of counts at the point of
- * interest in this image.  given a collection of f(k;T) values, we need to
- * determine the model f(k;T) = A(k) (T + dTk) / (T + dTo) where dTk is the shutter
- * error at the given position, dTo is the shutter error at the reference
- * position, and A(k) is the scaling factor for the given position.
- 
- - load the configuration information
- - load the input file information, build pmFPAfile's for all inputs
- 
- - determine the reference point and detailed analysis regions from the config information
- - for each image
- -- measure the reference point counts
- - for each analysis region:
- -- measure shutter parameters (dTo, dTk, A):
- --- for each image:
- ---- measure counts at the region
- ---- divide by the reference counts
- --- linear extrapolation to find f(inf) = A(k)
- --- linear extrapolation to find f(0) = A(k) dTk / dTo
- --- linear interpolation to find coordinate where f(dTo) = A (1 + dTk/dTo) / 2
- --- non-linear fit of T, f(T) to f(k;T) = A(k) (T + dTk) / (T + dTo)
- - use the collection of dTo values to choose a best value for dTo (median)
- - for each image pixel
- -- divide by the reference counts
- -- generate the vectors T, f(T)
- -- linear fit of T, f(T) to f(k;T) = A(k) (T + dTk) / (T + dTo) using dTo above
- -- save dTk, A(k) in output image pixels
- -- apply dTk, A(k) to measure residual images
- -- generate residual FITS/JPEG images
- 
-*/
-
 #if HAVE_CONFIG_H
 #include <config.h>
@@ -63 +11 @@
 #include "pmShutterCorrection.h"
 #include "psVectorBracket.h"
+
+/// Measure shutter correction:
+///
+/// input  : collection of shutter correction exposures (pre-processed)
+/// output : a shutter correction image
+///
+/// The measurement could be performed on any focal-plane unit at a time. for GPC, the obvious scale is to
+/// measure the effect on the entire focal plane at once, with a single reference point in the field.  this is
+/// a little more complex than just measuring the effect for a single 2D image array.  the reference point and
+/// the detailed analysis points need to be defined for the entire hierarchy rather than just as coordinate
+/// pairs or regions.  a pmFPAview would be a natural element with which to define these points, but at the
+/// moment, the pmFPAview structure defines a band in the CCD, not a coordinate.  An option is to instead
+/// specify the reference locations as a pmFPAview coupled with a psRegion, though we need to be careful not
+/// to over-specify the pixels (ie, conflict between pmFPAview and psRegion).
+///
+/// At each point in an image with exposure time T, we measure f(k;T) = F(k;T) / F(0;T) where k is the
+/// coordinate of the point of interest, 0 is the reference coordinate, and F(k;T) is the measured number of
+/// counts at the point of interest in this image.  given a collection of f(k;T) values, we need to determine
+/// the model f(k;T) = A(k) (T + dTk) / (T + dTo) where dTk is the shutter error at the given position, dTo is
+/// the shutter error at the reference position, and A(k) is the scaling factor for the given position.
+///
+/// The process for generating a shutter correction is as follows:
+/// - for each image
+/// -- measure the reference point counts
+/// - for each analysis region:
+/// -- measure shutter parameters (dTo, dTk, A):
+/// --- for each image:
+/// ---- measure counts at the region
+/// ---- divide by the reference counts
+/// --- linear extrapolation to find f(inf) = A(k)
+/// --- linear extrapolation to find f(0) = A(k) dTk / dTo
+/// --- linear interpolation to find coordinate where f(dTo) = A (1 + dTk/dTo) / 2
+/// --- non-linear fit of T, f(T) to f(k;T) = A(k) (T + dTk) / (T + dTo)
+/// - use the collection of dTo values to choose a best value for dTo (median)
+/// - for each image pixel
+/// -- divide by the reference counts
+/// -- generate the vectors T, f(T)
+/// -- linear fit of T, f(T) to f(k;T) = A(k) (T + dTk) / (T + dTo) using dTo above
+/// -- save dTk, A(k) in output image pixels
+/// -- apply dTk, A(k) to measure residual images
+/// -- generate residual FITS/JPEG images
+
 
 static void pmShutterCorrectionFree(pmShutterCorrection *pars)
@@ -360 +350 @@
 #define MEASURE_SAMPLES 4
 
-psImage *pmShutterCorrectionMeasure(const psVector *exptimes, // Exposure times
-                                    const psArray *images, // Input images
-                                    const psArray *weights, // Weight images
-                                    const psArray *masks, // Mask images
-                                    unsigned int size, // Size of samples
-                                    psStatsOptions meanStat, // Statistic to use for mean
-                                    psStatsOptions stdevStat, // Statistic to use for stdev
-                                    int nIter, // Number of iterations per pixel
-                                    float rej, // Rejection limit
-                                    psMaskType maskVal // Mask value
-                                   )
+psImage *pmShutterCorrectionMeasure(const psVector *exptimes, const psArray *images, const psArray *weights,
+                                    const psArray *masks, unsigned int size, psStatsOptions meanStat,
+                                    psStatsOptions stdevStat, int nIter, float rej, psMaskType maskVal)
 {
     PS_ASSERT_VECTOR_NON_NULL(exptimes, NULL);
@@ -376 +358 @@
     PS_ASSERT_ARRAY_NON_NULL(images, NULL);
     if (masks) {
-        // XXX ASSERT not defined
-        // PS_ASSERT_ARRAYS_SIZE_EQUAL(images, masks, NULL);
+        PS_ASSERT_ARRAYS_SIZE_EQUAL(images, masks, NULL);
     }
     if (weights) {
-        // XXX ASSERT not defined
-        // PS_ASSERT_ARRAYS_SIZE_EQUAL(images, weights, NULL);
+        PS_ASSERT_ARRAYS_SIZE_EQUAL(images, weights, NULL);
     }
     long num = images->n;               // Number of images
@@ -576 +556 @@
 
 
-bool pmShutterCorrectionApply(pmReadout *readout, // Readout to which to apply shutter correction
-                              const pmReadout *shutter // Shutter correction readout
-                             )
+bool pmShutterCorrectionApply(pmReadout *readout, const pmReadout *shutter)
 {
     PS_ASSERT_PTR_NON_NULL(readout, false);