Changeset 18556

Timestamp:

Jul 15, 2008, 10:26:37 AM (18 years ago)

Author:

eugene

Message:

re-org and cleanup of the mask bits to make it consistent with the pmConfigMaskSetBits concepts; ensure mark and mask are correctly used and supplied to psphot

Location:

trunk/ppImage/src

Files:

• Makefile.am (modified) (2 diffs)
• ppImage.h (modified) (3 diffs)
• ppImageDetrendReadout.c (modified) (1 diff)
• ppImageLoop.c (modified) (1 diff)
• ppImageMetadataStats.c (modified) (2 diffs)
• ppImageMosaic.c (modified) (1 diff)
• ppImageOptions.c (modified) (2 diffs)
• ppImageParseCamera.c (modified) (4 diffs)
• ppImagePixelStats.c (modified) (2 diffs)
• ppImageReplaceBackground.c (modified) (1 diff)
• ppImageSetMaskBits.c (added)
• ppImageStats.c (modified) (1 diff)

trunk/ppImage/src/Makefile.am

@@ -29 +29 @@
         ppImageReplaceBackground.c \
         ppImageDefineFile.c \
+        ppImageSetMaskBits.c \
         ppImageFileCheck.c \
         ppImageVersion.c \
@@ -58 +59 @@
         ppImageReplaceBackground.c \
         ppImageDefineFile.c \
+        ppImageSetMaskBits.c \
         ppImageFileCheck.c \
         ppImageVersion.c \

trunk/ppImage/src/ppImage.h

@@ -56 +56 @@
     // make values for abstract concepts of masking
     psMaskType maskValue;               // apply this bit-mask to choose masked bits
+    psMaskType markValue;               // apply this bit-mask to choose masked bits
     psMaskType satMask;                 // Mask value to give saturated pixels
     psMaskType badMask;                 // Mask value to give bad pixels
@@ -101 +102 @@
 // Determine what type of camera, and initialise
 ppImageOptions *ppImageParseCamera(pmConfig *config);
+bool ppImageSetMaskBits (pmConfig *config, ppImageOptions *options);
 
 // Loop over the input
@@ -134 +136 @@
 bool ppImageMosaicFPA (pmConfig *config, const ppImageOptions *options,
                        const char *outFile, const char *inFile);
+
+bool ppImageSetMaskBits (pmConfig *config, ppImageOptions *options);
 
 void ppImageFileCheck (pmConfig *config);

trunk/ppImage/src/ppImageDetrendReadout.c

@@ -74 +74 @@
     if (options->doShutter) {
         pmReadout *shutter = pmFPAfileThisReadout(config->files, detview, "PPIMAGE.SHUTTER");
-        if (!pmShutterCorrectionApply(input, shutter, pmConfigMask("FLAT", config))) {
+        if (!pmShutterCorrectionApply(input, shutter, pmConfigMaskGet("FLAT", config))) {
             return false;
         }

trunk/ppImage/src/ppImageLoop.c

@@ -62 +62 @@
                     continue;
                 }
+
+                // XXX set the options->*Mask values here (after the mask images have been loaded
+                // and before any of the value are used)
+                if (!ppImageSetMaskBits (config, options)) 
+                    ESCAPE ("Unable to set bit masks");
 
                 // perform the detrend analysis

trunk/ppImage/src/ppImageMetadataStats.c

@@ -13 +13 @@
         return true;
     }
-
-    psMaskType maskVal = options->satMask | options->badMask | options->maskValue;
 
     // Extract statistics from the last output fpa
@@ -50 +48 @@
     pmFPAview *view = pmFPAviewAlloc(0);
 
-    if (!ppStatsMetadata(stats, output->fpa, view, maskVal, config)) {
+    if (!ppStatsMetadata(stats, output->fpa, view, options->maskValue, config)) {
         psError(PS_ERR_UNEXPECTED_NULL, false, "Unable to generate stats for image.");
         psFree(view);

trunk/ppImage/src/ppImageMosaic.c

@@ -32 +32 @@
             in->name, out->name, in->xBin, in->yBin, out->xBin, out->yBin);
 
-    // XXX mosaic the chip, making a deep copy.  this has the side effect of making the
-    // output image products pure trimmed images, but also increases the memory footprint.
+    // Mosaic the chip, making a deep copy.  This has the side effect of making the output
+    // image products pure trimmed images, but also increases the memory footprint.
     status = pmChipMosaic(outChip, inChip, true, options->blankMask);
     return status;

trunk/ppImage/src/ppImageOptions.c

@@ -50 +50 @@
 
     // default flags for various activities
-    options->maskValue       = 0x00;    // Default mask value
-    options->satMask         = 0x00;    // Saturated pixels
-    options->badMask         = 0x00;    // Bad pixels
-    options->flatMask        = 0x00;    // Bad flat pixels
-    options->blankMask       = 0x00;    // Blank (no data, cell gap) pixels
+    options->maskValue       = 0x00;    // Default mask value (used to skip / ignore pixels)
+    options->satMask         = 0x00;    // Saturated pixels (supplied to pmReadoutGenerateMask)
+    options->badMask         = 0x00;    // Bad (low) pixels (supplied to pmReadoutGenerateMask)
+    options->flatMask        = 0x00;    // Bad flat pixels (supplied to pmFlatField)
+    options->blankMask       = 0x00;    // Blank (no data, cell gap) pixels (supplied to pmChipMosaic, pmFPAMosaic)
+    options->markValue       = 0x00;    // A safe bit for internal marking
 
     // Non-linearity default options
@@ -190 +191 @@
     options->doWeightBuild = psMetadataLookupBool(NULL, recipe, "WEIGHT.BUILD");
 
-    // Mask recipe options
+    // Mask recipe options (note that mask bit values are set in ppImageSetMaskBits.c)
     options->doMask = psMetadataLookupBool(NULL, recipe, "MASK");
-    const char *masks = psMetadataLookupStr(&status, recipe, "MASK.VALUE");
-    if (status) {
-        options->maskValue = pmConfigMask(masks, config);
-    }
-    options->satMask = pmConfigMask("SAT", config);
-    options->badMask = pmConfigMask("BAD", config);
-    options->flatMask = pmConfigMask("FLAT", config);
-    options->blankMask = pmConfigMask("BLANK", config);
-    // XXX should it be an error for these to not exist?
 
     options->doBias = psMetadataLookupBool(NULL, recipe, "BIAS");

trunk/ppImage/src/ppImageParseCamera.c

@@ -20 +20 @@
     }
 
-    // if MASK or WEIGHT was supplied on command line, bind files to 'input'
+    // if MASK or WEIGHT was supplied on command line, bind files to 'input'.
     // the mask and weight will be mosaicked with the image
     pmFPAfile *inputMask = pmFPAfileBindFromArgs(&status, input, config, "PPIMAGE.INPUT.MASK", "PPIMAGE.INPUT.MASK");
@@ -27 +27 @@
         return NULL;
     }
-    if (inputMask && inputMask->type != PM_FPA_FILE_MASK) {
+    if (inputMask) {
+      if (inputMask->type != PM_FPA_FILE_MASK) {
         psError(PS_ERR_IO, true, "PPIMAGE.INPUT.MASK is not of type MASK");
         return NULL;
+      }
     }
 
@@ -66 +68 @@
     }
     if (options->doMask) {
+
         if (!ppImageDefineFile (config, input->fpa, "PPIMAGE.MASK", "MASK", PM_FPA_FILE_MASK, PM_DETREND_TYPE_MASK)) {
             psError (PS_ERR_IO, false, "Can't find a mask image source");
@@ -71 +74 @@
             return NULL;
         }
-        // Need to read the names of bit masks from the mask header and set them in the recipe
+        // XXX have ppImageDefineFile return the pmFPAfile?
+        pmFPAfile *mask = psMetadataLookupPtr(&status, config->files, "PPIMAGE.MASK");
+        psAssert (mask, "mask not defined?  not possible!");
+
+        // Need to read the names of bit masks from the mask header and set them in the
+        // recipe.  If we are loading this from the detrend db, this action will happen
+        // when the file is resolved.
+        if (!mask->detrend) {
+            // XXX need to load the mask bit names from one of the headers
+            // this grabs the first available hdu : no guarantee that it will be valid, though
+            pmHDU *hdu = pmHDUGetFirst (mask->fpa);
+            if (!hdu) {
+                psError(PS_ERR_IO, true, "no valid HDU for PPIMAGE.INPUT.MASK");
+                return NULL;
+            }
+            // XXX is this consistent with the pmConfigMaskReadHeader call above?
+            if (!pmConfigMaskReadHeader (config, hdu->header)) {
+                psError(PS_ERR_IO, false, "error in mask bits");
+                return NULL;
+            }
+        }
     }
     if (options->doShutter) {

trunk/ppImage/src/ppImagePixelStats.c

@@ -9 +9 @@
 
     bool mdok;              // Status of MD lookup
-
-    psMaskType maskVal = options->satMask | options->badMask | options->maskValue;
 
     // loop over the cells/readouts for this chip
@@ -48 +46 @@
         }
 
-        if (!ppStatsPixels(stats, output->fpa, view, maskVal, config)) {
+        if (!ppStatsPixels(stats, output->fpa, view, options->maskValue, config)) {
             psError(PS_ERR_UNEXPECTED_NULL, false, "Unable to generate stats for image.");
             psFree (view);

trunk/ppImage/src/ppImageReplaceBackground.c

@@ -40 +40 @@
     psAssert (replaceSkyMode != MODE_NONE, "replace sky mode not defined");
 
-    // define the mask value to be used in ppImage
-    psMaskType maskVal  = options->satMask | options->badMask | options->flatMask | options->blankMask;
+    // XXX Should this be options->maskValue or & ~options->satMask? the latter will leave saturated pixels high
+    // psMaskType maskVal  = options->maskValue & ~options->satMask;
+    psMaskType maskVal  = options->maskValue;
 
     pmFPAfile *modelFile = NULL;

trunk/ppImage/src/ppImageStats.c

@@ -57 +57 @@
             }
 
-            if (!ppStatsFPA(stats, output->fpa, view,
-                         options->satMask | options->badMask | options->maskValue,
-                         config)) {
+            if (!ppStatsFPA(stats, output->fpa, view, options->maskValue, config)) {
                 psError(PS_ERR_UNEXPECTED_NULL, false, "Unable to generate stats for image.");
                 psFree(view);