Changeset 31066

Timestamp:

Mar 27, 2011, 12:08:17 PM (15 years ago)

Author:

eugene

Message:

cleaned up some of the commented out PATTERN.* code; added clarifying comments regarding recipe / format rules for PATTERN.*

Location:

trunk/ppImage/src

Files:

• ppImageDetrendPattern.c (modified) (6 diffs)
• ppImageOptions.c (modified) (1 diff)

trunk/ppImage/src/ppImageDetrendPattern.c

@@ -23 +23 @@
     assert(inputView->readout == -1);
 
+    // PATTERN.ROW is selected by the recipe.  If it is selected, we search for the table
+    // PATTERN.ROW.SUBSET.  If this is found in our format file, we use that version;
+    // otherwise, we use the table provided in the recipe file "ppImage.config".  Within that
+    // table, we select the entry that matches our CHIP.NAME.  This will be either a boolean or
+    // a string of bits.  If it is a boolean, it specified whether or not to correct the entire
+    // chip; if it is a string, the bits specify which cells to correct (sequence is order of
+    // CELLS in the format:CHIPS metadata table)
+
+    // We also check the chip header for the boolean 'PTRN_ROW' : if this is true, we have
+    // already applied this correct to this data, so we simply skip the correction for this
+    // chip.
+
     if (options->doPatternRow) {
         bool status;
@@ -28 +40 @@
         if (psMetadataLookupBool(NULL,hdu->header,"PTRN_ROW")) {
           psLogMsg("ppImage", PS_LOG_INFO, "Not performing row pattern correction as it has already been done.");
+          goto pattern_cell;
         }
-        else {
-          pmFPAfile *input = psMetadataLookupPtr(&status, config->files, "PPIMAGE.INPUT");
-          pmFPAview *view = pmFPAviewAlloc(0); // View for local processing
-          *view = *inputView;
-          while ((cell = pmFPAviewNextCell(view, input->fpa, 1)) != NULL) {
+
+        pmFPAfile *input = psMetadataLookupPtr(&status, config->files, "PPIMAGE.INPUT");
+        pmFPAview *view = pmFPAviewAlloc(0); // View for local processing
+        *view = *inputView;
+        while ((cell = pmFPAviewNextCell(view, input->fpa, 1)) != NULL) {
             if (!cell->process || !cell->file_exists) {
-              continue;
+                continue;
             }
             if (!pmFPAfileIOChecks(config, view, PM_FPA_BEFORE)) {
-              ESCAPE(false, "load failure for Cell");
+                ESCAPE(false, "load failure for Cell");
             }
             
@@ -56 +69 @@
             if (!doPattern) continue;
 
+            // A very detailed log message. 
             const char *chipName = psMetadataLookupStr(NULL, chip->concepts, "CHIP.NAME");
             const char *cellName = psMetadataLookupStr(NULL, cell->concepts, "CELL.NAME");
-            psLogMsg("ppImage", PS_LOG_INFO, "Performing row pattern correction for %s, %s\n",
-                     chipName, cellName);
+            psLogMsg("ppImage", PS_LOG_INFO, "Performing row pattern correction for %s, %s\n", chipName, cellName);
 
             // process each of the readouts
@@ -80 +93 @@
             }
 
-          }
-          psMetadataAddBool(hdu->header, PS_LIST_TAIL, "PTRN_ROW",PS_META_REPLACE,"PATTERN.ROW correction applied",true);
-          psFree(view);
         }
+        psMetadataAddBool(hdu->header, PS_LIST_TAIL, "PTRN_ROW",PS_META_REPLACE,"PATTERN.ROW correction applied",true);
+        psFree(view);
     }
+
+ pattern_cell:
+
+    // see the comment for PATTERN.ROW; the same rules apply for PATTERN.CELL
 
     if (options->doPatternCell) {
@@ -95 +111 @@
         if (psMetadataLookupBool(NULL,hdu->header,"PTRN_CEL")) {
           psLogMsg("ppImage", PS_LOG_INFO, "Not performing cell pattern correction as it has already been done.");
+          goto pattern_done;
         }
-        else {
-          for (int i = 0; i < chip->cells->n; i++) {
+
+        for (int i = 0; i < chip->cells->n; i++) {
             view->cell = i;
 
@@ -115 +132 @@
             }
 
-          }
+        }
 
-          // Tweak the cells
-          if (!pmPatternCell(chip, tweak, options->patternCellBG, options->patternCellMean,
-                             options->maskValue, options->darkMask)) {
-              psFree(tweak);
-              psFree(view);
-              return false;
-          }
-          psFree(tweak);
-          psFree(view);
+        // Tweak the cells
+        if (!pmPatternCell(chip, tweak, options->patternCellBG, options->patternCellMean,
+                           options->maskValue, options->darkMask)) {
+            psFree(tweak);
+            psFree(view);
+            return false;
+        }
+        psFree(tweak);
+        psFree(view);
 
-          psMetadataAddBool(hdu->header, PS_LIST_TAIL, "PTRN_CEL",PS_META_REPLACE,"PATTERN.CELL correction applied",true);
-        }
+        psMetadataAddBool(hdu->header, PS_LIST_TAIL, "PTRN_CEL",PS_META_REPLACE,"PATTERN.CELL correction applied",true);
     }
 
+ pattern_done:
     return(true);
 }

trunk/ppImage/src/ppImageOptions.c

@@ -239 +239 @@
     options->doShutter = psMetadataLookupBool(NULL, recipe, "SHUTTER");
 
-    // Look for pattern correction options in the camera format. If not found, look in the recipe.
-/*     if (psMetadataLookup(format, "PATTERN.ROW")) { */
-/*       options->doPatternRow = psMetadataLookupBool(NULL, format, "PATTERN.ROW"); */
-/*     } */
-/*     else { */
+    // PATTERN.ROW is selected by the recipe.  If it is selected, we search for the table
+    // PATTERN.ROW.SUBSET.  If this is found in our format file, we use that version;
+    // otherwise, we use the table provided in the recipe file "ppImage.config".  Within that
+    // table, we select the entry that matches our CHIP.NAME.  This will be either a boolean or
+    // a string of bits.  If it is a boolean, it specified whether or not to correct the entire
+    // chip; if it is a string, the bits specify which cells to correct (sequence is order of
+    // CELLS in the format:CHIPS metadata table)
+
+    // We also check the chip header for the boolean 'PTRN_ROW' : if this is true, we have
+    // already applied this correct to this data, so we simply skip the correction for this
+    // chip.
+
     options->doPatternRow = psMetadataLookupBool(NULL, recipe, "PATTERN.ROW");
-/*     } */
-/*     if (psMetadataLookup(format, "PATTERN.CELL")) { */
-/*       options->doPatternCell = psMetadataLookupBool(NULL, format, "PATTERN.CELL"); */
-/*     } */
-/*     else { */
     options->doPatternCell = psMetadataLookupBool(NULL, recipe, "PATTERN.CELL");
-/*     } */
+
     options->doMaskStats = psMetadataLookupBool(NULL, recipe, "MASK.STATS");
     options->addNoise = psMetadataLookupBool(NULL, recipe, "ADDNOISE");