Changeset 35531 for trunk/ppImage/src

Timestamp:

May 7, 2013, 4:01:35 PM (13 years ago)

Author:

bills

Message:

add new recipe options to ppImage to control application of an auxiliary
mask. This is intended to be a more selective mask that will be used by M31
and STS projects for their reprocessing. This masking is added to the
mask constructed during detrending after the cells have bee mosaiced.

Location:

trunk/ppImage/src

Files:

• Makefile.am (modified) (1 diff)
• ppImage.h (modified) (3 diffs)
• ppImageAuxiliaryMask.c (modified) (8 diffs)
• ppImageDetrendReadout.c (modified) (1 diff)
• ppImageLoop.c (modified) (1 diff)
• ppImageOptions.c (modified) (4 diffs)

trunk/ppImage/src/Makefile.am

@@ -65 +65 @@
         ppImageMemory.c \
         ppImageAddNoise.c \
-        ppImageRandomGaussian.c
+        ppImageRandomGaussian.c \
+        ppImageAuxiliaryMask.c
 
 CLEANFILES = *~

trunk/ppImage/src/ppImage.h

@@ -30 +30 @@
     bool doMaskLow;                     // mask low pixels
     bool doMask;                        // Mask bad pixels
+    bool doAuxMask;                     // apply auxillary mask
     bool doNonLin;                      // Non-linearity correction
     bool doOverscan;                    // Overscan subtraction
@@ -126 +127 @@
   psU16 maskstat_magic;
   psU16 maskstat_advisory;
+
+  psString auxVideoMask;                // auxillary video mask file
   
 } ppImageOptions;
@@ -312 +315 @@
 void ppImageRandomGaussianFree(void);
 
+bool ppImageAuxiliaryMask(pmConfig *config, const pmFPAview *view, const ppImageOptions *options);
 
 #endif

trunk/ppImage/src/ppImageAuxiliaryMask.c

@@ -40 +40 @@
 }
 
+bool recordFileInHeader(pmChip *chip, psString tag, psString desc, psString filename)
+{
+    pmHDU *hdu = pmHDUGetHighest(chip->parent, chip, NULL);
+
+    // strip off the directories and nebulous bits
+    char *base = filename;
+    for (char *new = base; (new = strpbrk(base, "/:")); base = new + 1);
+
+    psMetadataAddStr(hdu->header, PS_LIST_TAIL, tag, PS_META_DUPLICATE_OK, desc, base);
+    return true;
+}
+
 // In this function, we augment the mask with the more conservative auxiliary mask
 bool ppImageAuxiliaryMask(pmConfig *config, const pmFPAview *view, const ppImageOptions *options)
@@ -51 +63 @@
     }
 
-    bool status;                        // Status of MD lookup
+    bool status;
+    // Our target chip
     pmFPAfile *input = psMetadataLookupPtr(&status, config->files, "PPIMAGE.CHIP"); // File to correct
     if (!status) {
@@ -58 +71 @@
     }
 
+    // Find a suitable detRun with type AUXMASK
+
     psTime *time = psMetadataLookupPtr(NULL, input->fpa->concepts, "FPA.TIME");
     if (time->sec == 0 && time->nsec == 0) {
@@ -63 +78 @@
     }
 
-    // XXX careful about this: is this set correctly in the camera.config files?
     char *cameraName = psMetadataLookupStr(NULL, input->fpa->concepts, "FPA.CAMERA");
     pmDetrendSelectOptions *detrendOptions = pmDetrendSelectOptionsAlloc(cameraName, *time, PM_DETREND_TYPE_AUXMASK);
@@ -80 +94 @@
     }
     
-#ifdef notdef
-    psMetadata *ppImageRecipe = psMetadataLookupPtr(NULL, config->recipes, RECIPE_NAME);
-    psAssert(ppImageRecipe, "Need PPIMAGE recipe");
-    psMetadata *psphotRecipe = psMetadataLookupPtr(NULL, config->recipes, PSPHOT_RECIPE);
-    psAssert(psphotRecipe, "Need PSPHOT recipe");
-
-    // XXX Should this be options->maskValue or options->maskValue & ~options->satMask?
-    //     The latter will leave saturated pixels high
-    psImageMaskType maskVal = options->maskValue;
-
-    // user-defined masks to test for good/bad pixels (build from recipe list if not yet set)
-    psMetadataAddImageMask(psphotRecipe, PS_LIST_TAIL, "MASK.PSPHOT", PS_META_REPLACE, "user-defined mask", maskVal);
-#endif
-
+    // Go find the readout
+    // code to find the readouts was adapted from ppImageSubtractBackground
     // XXX: shouldn't most of these psWarnings be psAsserts?
 
@@ -129 +131 @@
     psImage *mask = ro->mask;
 
-    // now read the mask file
+    // now read the auxiliary mask file
     psString class_id = psMetadataLookupStr(NULL, chip->concepts, "CHIP.NAME");
 
@@ -139 +141 @@
 
     psFree(results);
+    // record that we read this file in the config dump file.
+    // Note: this value isn't used during updates though.
+    pmConfigRunFilenameAddRead(config, "PPIMAGE.AUXMASK", auxMaskFileName);
+    recordFileInHeader(chip, "DETREND.AUXMASK", "auxiliary mask", auxMaskFileName);
 
     psImage *auxMask = readAuxiliaryMask(config, auxMaskFileName);
     psFree(auxMaskFileName);
     if (!auxMask) {
-        // readAuxiliaryMask prints enough diagnostic information
+        psError(PS_ERR_UNKNOWN, false, "failed to read auxiliary mask file");
         return false;
     }
@@ -151 +157 @@
         psImage *videoMask = readAuxiliaryMask(config, options->auxVideoMask);
         if (!videoMask) {
+            psError(PS_ERR_UNKNOWN, false, "failed to read auxiliary video mask file");
             return false;
         }
-        // auxMask *= videoMask
+        pmConfigRunFilenameAddRead(config, "PPIMAGE.AUXVIDEOMASK", options->auxVideoMask);
+        recordFileInHeader(chip, "DETREND.AUXVIDEOMASK", "auxiliary video mask", options->auxVideoMask);
+
+        // compute auxMask *= videoMask
         if (!psBinaryOp(auxMask, auxMask, "*", videoMask)) {
             psError(PS_ERR_UNKNOWN, false, "mulitplication of auxiliary mask and auxiliary video mask failed");

trunk/ppImage/src/ppImageDetrendReadout.c

@@ -50 +50 @@
         char *Vptr = strchr(psMetadataLookupStr(NULL,input->parent->parent->hdu->header,"CELLMODE"),'V');
         if (Vptr) {
-          hasVideo = true;
+          hasVideo = options->hasVideo = true;
           psLogMsg ("ppImage.detrend", PS_LOG_INFO, "VIDEO: %d %d %d\n",(int) options->hasVideo,(int) options->useVideoDark, (int) options->useVideoMask);
         }

trunk/ppImage/src/ppImageLoop.c

@@ -188 +188 @@
             ESCAPE("Unable to mosaic chip");
         }
+
+        if (!ppImageAuxiliaryMask(config, view, options)) {
+            ESCAPE("Unable to apply auxiliary mask");
+        }
+
         timeDetrend += psTimerClear(TIMER_DETREND);
 

trunk/ppImage/src/ppImageOptions.c

@@ -10 +10 @@
     // psFree(options->nonLinearData);
     // psFree(options->nonLinearSource);
+    psFree(options->auxVideoMask);
 }
 
@@ -24 +25 @@
     options->doVarianceBuild = false;   // Build internal variance
     options->doMask          = false;   // Mask bad pixels
+    options->doAuxMask       = false;   // apply auxillary mask
     options->doNonLin        = false;   // Non-linearity correction
     options->doOverscan      = false;   // Overscan subtraction
@@ -116 +118 @@
     options->normClass       = NULL;    // per-class normalizations refer to this class
 
+    options->auxVideoMask    = NULL;    // auxillary video mask file name
+
     return options;
 }
@@ -228 +232 @@
     options->doMaskBurntool  = psMetadataLookupBool(NULL, recipe, "MASK.BURNTOOL");
     options->doVarianceBuild = psMetadataLookupBool(NULL, recipe, "VARIANCE.BUILD");
+    options->doAuxMask       = psMetadataLookupBool(NULL, recipe, "MASK.AUXMASK");
+    if (options->doAuxMask) {
+        // if we are applying an auxiliary mask we can optionally apply another
+        // mask to video cells only. 
+        psString auxVideoMask = psMetadataLookupStr(NULL, recipe, "AUX.VIDEO.MASK");
+        // save the value if defined and not the value "NULL"
+        if (auxVideoMask && strcmp(auxVideoMask, "NULL")) {
+            options->auxVideoMask = psStringCopy(auxVideoMask);
+        }
+    }
 
     // Mask recipe options (note that mask bit values are set in ppImageSetMaskBits.c)