Changeset 6205 for trunk/psModules/src/imcombine/pmReadoutCombine.h

Timestamp:

Jan 26, 2006, 11:10:51 AM (20 years ago)

Author:

gusciora

Message:

Implemented the polynomial alloc argument changes.

File:

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

trunk/psModules/src/imcombine/pmReadoutCombine.h

@@ -5 +5 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-11-15 20:09:03 $
+ *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-01-26 21:10:50 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -72 +72 @@
 pmFringePoint;
 
+
+/**
+ * 
+ * The input array fluxLevels consists of Ni vectors, one per mosaic image.
+ * Each vector consists of Nj elements, each a measurement of the input
+ * flat-field image flux levels. All of these vectors must be constructed with
+ * the same number of elements, or the function will return an error. If a chip
+ * is missing from a particular image, that element should be set to NaN. The
+ * vector chipGains supplies initial guesses for the chip gains. If the vector
+ * contains the values 0.0 or NaN for any of the elements, the gain is set to the
+ * mean of the valid values. If the vector length does not match the number of
+ * chips, an warning is raised, all chip gain guesses will be set to 1.0, and the
+ * vector length modified to match the number of chips defined by the supplied
+ * fluxLevels. The sourceFlux input vector must be allocated (not NULL), but the
+ * routine will set the vector length to the number of source images regardless
+ * of the initial state of the vector. All vectors used by this function must be
+ * of type PS_DATA_F64.
+ * 
+ */
+bool pmFlatNormalization(
+    psVector *sourceFlux,
+    psVector *chipGains,
+    psArray *fluxLevels
+);
+
+
 #endif