Changeset 6842 for branches/rel10_ifa/psModules/src/detrend/pmFringeStats.h

Timestamp:

Apr 12, 2006, 1:50:45 PM (20 years ago)

Author:

Paul Price

Message:

pmFringeStats stuff compiles; separated pmFringeStats into pmFringeRegions and pmFringeStats --- the regions are common to all the images, while the stats are measured per image.

File:

• branches/rel10_ifa/psModules/src/detrend/pmFringeStats.h (modified) (6 diffs)

branches/rel10_ifa/psModules/src/detrend/pmFringeStats.h

@@ -5 +5 @@
  *  @author Eugene Magnier, IfA
  *
- *  @version $Revision: 1.1.2.2 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-04-04 18:41:38 $
+ *  @version $Revision: 1.1.2.3 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-04-12 23:50:45 $
  *
  *  Copyright 2004 IfA, University of Hawaii
@@ -14 +14 @@
 # define PM_FRINGE_STATS
 
-/** Fringe Stats structure to hold the fringe statistics
- *   for a given image
+/** Structure to hold the fringe measurement regions.
  */
 typedef struct
@@ -25 +24 @@
     psU32 nX;    // large-scale smoothing in x (col)
     psU32 nY;    // large-scale smoothing in y (row)
-    psVector x;    // fringe point coordinates (col)
-    psVector y;    // fringe point coordinates (row)
-    psVector f;    // fringe point median
-    psVector df;   // fringe point stdev
-    psVector mask;   // fringe point on/off mask
+    psVector *x;    // fringe point coordinates (col)
+    psVector *y;    // fringe point coordinates (row)
+    psVector *mask;   // fringe point on/off mask
 }
-pmFringeStats;
+pmFringeRegions;
 
-pmFringeStats *pmFringeStatsAlloc (
+pmFringeRegions *pmFringeRegionsAlloc (
     int nPts,     // number of points to create
     int dX,     // half-width of fringe boxes
@@ -40 +37 @@
     int nY    // smoothing scale in y
 );
+
+/** Structure to hold the fringe measurements for a particular image
+ */
+typedef struct
+{
+    pmFringeRegions *regions;           // Fringe regions
+    psVector *f;    // fringe point median
+    psVector *df;   // fringe point stdev
+}
+pmFringeStats;
+
+pmFringeStats *pmFringeStatsAlloc(pmFringeRegions *regions);
+
 
 /** the pmFringeScale structure defines the relationship between two fringe measurements
@@ -60 +70 @@
  *  @return  bool: True or false for success or failure
  */
-bool pmFringeStatsMeasure(
-    pmFringeStats *fringe,  ///< results are placed here
-    psImage *image   ///< measure fringes on this image
+pmFringeStats *pmFringeStatsMeasure(
+    pmFringeRegions *fringe,            ///< fringe regions
+    pmReadout *readout,                 ///< measure fringes on this readout
+    psMaskType maskVal                  ///< Mask value for statistics
 );
 
@@ -68 +79 @@
  *
  *  Given a science image, a set of fringe stats and a matched set of fringe images, correct the science image
- *  for the fringe images.  
+ *  for the fringe images.
  *
- *  @return  psImage: corrected science image
+ *  @return  psImage: summed fringe image
  */
-psImage *pmFringeCorrect(
-    psImage *out,   // place corrected image here (allocate if NULL)
-    psMetadata *info,   // place info about results here
-    psImage *science,   // image to be corrected
-    psArray *fringeImage,  // fringe images to use in correction
-    psArray *fringeStats  // fringe stats to use in correction
-);
+psImage *pmFringeCorrect(pmReadout *in, // place info about results here
+                         pmFringeRegions *fringes, // The fringe regions used
+                         psArray *fringeImages, // fringe images to use in correction
+                         psArray *fringeStats, // fringe stats to use in correction
+                         psMaskType maskVal // Value to mask
+                        );
 
 # endif