Changeset 14209 for trunk/ppImage/src/ppImage.h

Timestamp:

Jul 13, 2007, 5:41:04 PM (19 years ago)

Author:

eugene

Message:

adding options for mask and weight outputs, some cleanups

File:

• trunk/ppImage/src/ppImage.h (modified) (2 diffs)

trunk/ppImage/src/ppImage.h

@@ -21 +21 @@
 // Options for ppImage processing
 typedef struct {
+    // actions which ppImage should perform
     bool doMask;                        // Mask bad pixels
-    psMaskType maskValue;               // apply this bit-mask to choose masked bits
-    psMaskType satMask;                 // Mask value to give saturated pixels
-    psMaskType badMask;                 // Mask value to give bad pixels
-    psMaskType flatMask;                // Mask value to give bad flat pixels
-    psMaskType blankMask;               // Mask value to give blank pixels
-
+    bool doNonLin;                      // Non-linearity correction
+    bool doOverscan;                    // Overscan subtraction
     bool doBias;                        // Bias subtraction
     bool doDark;                        // Dark subtraction
@@ -36 +33 @@
     bool doAstromChip;                  // per-chip Astrometry
     bool doAstromMosaic;                // full-mosaic Astrometry
-    bool doAddstar;                     // add results to object database?
+    bool doStats;                       // call ppStats on the image
 
-    bool doOverscan;                    // Overscan subtraction
-    pmOverscanOptions *overscan;        // Overscan options
+    // output files requested
+    bool BaseFITS;
+    bool BaseMaskFITS;
+    bool BaseWeightFITS;
 
-    bool doNonLin;                      // Non-linearity correction
+    bool ChipFITS;
+    bool ChipMaskFITS;
+    bool ChipWeightFITS;
+
+    bool FPA1FITS;
+    bool FPA2FITS;
+    bool Bin1FITS;
+    bool Bin1JPEG;
+    bool Bin2FITS;
+    bool Bin2JPEG;
+
+    // make values for abstract concepts of masking
+    psMaskType maskValue;               // apply this bit-mask to choose masked bits
+    psMaskType satMask;                 // Mask value to give saturated pixels
+    psMaskType badMask;                 // Mask value to give bad pixels
+    psMaskType flatMask;                // Mask value to give bad flat pixels
+    psMaskType blankMask;               // Mask value to give blank pixels
+
+    // non-linear correction parameters
     psDataType nonLinearType;
     psMetadataItem *nonLinearData;
     void *nonLinearSource;
 
-    bool doStats;
+    // options for the analysis
+    pmOverscanOptions *overscan;        // Overscan options
 
-    bool BaseFITS;
-    bool ChipFITS;
-    bool FPA1FITS;
-    bool FPA2FITS;
+    // binning parameters
+    int xBin1;                          // x-binning, scale 1
+    int yBin1;                          // y-binning, scale 1
+    int xBin2;                          // x-binning, scale 2
+    int yBin2;                          // y-binning, scale 2
 
-    bool Bin1FITS;
-    bool Bin1JPEG;
-    int xBin1, yBin1;
-
-    bool Bin2FITS;
-    bool Bin2JPEG;
-    int xBin2, yBin2;
-
+    // parameters used by the fringe analysis
     float fringeRej;                    // Fringe rejection limit
     int fringeIter;                     // Fringe iterations
     float fringeKeep;                   // Fringe keep fraction
+
 } ppImageOptions;