Changeset 21183 for trunk/psModules/src/config/pmConfigMask.h

Timestamp:

Jan 26, 2009, 8:40:07 PM (17 years ago)

Author:

eugene

Message:

incorporating changes from 16bit mask upgrades (eam_branch_20081230)

File:

• trunk/psModules/src/config/pmConfigMask.h (modified) (3 diffs)

trunk/psModules/src/config/pmConfigMask.h

@@ -4 +4 @@
  *  @author Paul Price, IfA
  *
- *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2008-07-17 20:37:20 $
+ *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-01-27 06:39:38 $
  *  Copyright 2007 Institute for Astronomy, University of Hawaii
  */
@@ -20 +20 @@
 /// @{
 
+// structure to hold the properties of a mask value
+typedef struct {
+    char *badMaskName;                  // name for "bad" (i.e., mask me please) pixels
+    char *fallbackName;                 // Fallback name in case a bad mask name is not defined
+    psImageMaskType defaultMaskValue;   // Default value in case a bad mask name and its fallback are not defined
+    bool isBad; // include this value as part of the MASK.VALUE entry (generically bad)
+} pmConfigMaskInfo;
+
+// pmConfigMaskSetInMetadata examines named mask values and set the bits for maskValue and
+// markValue.  Ensures that the below-named mask values are set, and calculates the mask value
+// to catch all of the mask values marked as 'bad'.  Supplies the fallback name if the primary
+// name is not found, or the default values if the fallback name is not found.
+bool pmConfigMaskSetInMetadata(psImageMaskType *outMaskValue, // Value of MASK.VALUE, returned
+                               psImageMaskType *outMarkValue, // Value of MARK.VALUE, returned
+                               psMetadata *source  // Source of mask bits
+  );
+
+
+// Get a mask value by name(s)
+psImageMaskType pmConfigMaskGetFromMetadata(psMetadata *source, // Source of masks
+                                            const char *masks // Mask values to get
+  );
+
+
+// lookup an image mask value by name from a psMetadata, without requiring the entry to 
+// be of type psImageMaskType, but verifying that it will fit in psImageMaskType
+psImageMaskType psMetadataLookupImageMaskFromGeneric (bool *status, const psMetadata *md, const char *name);
+
+// Remove from the header keywords starting with the provided string
+int pmConfigMaskRemoveHeaderKeywords(psMetadata *header, // Header from which to remove keywords
+                                     const char *start // Remove keywords that start with this string
+  );
+
 /// Return a mask value given a list of symbolic names
 ///
 /// The mask values are derived from the MASKS recipe
-psMaskType pmConfigMaskGet(const char *masks, ///< List of symbolic names, space/comma delimited
+psImageMaskType pmConfigMaskGet(const char *masks, ///< List of symbolic names, space/comma delimited
                            const pmConfig *config ///< Configuration
     );
 
-bool pmConfigMaskSet(const pmConfig *config, const char *maskName, psMaskType maskValue);
+bool pmConfigMaskSet(const pmConfig *config, const char *maskName, psImageMaskType maskValue);
 
 // replace the named masks in the recipe with values in the header:
@@ -36 +69 @@
 bool pmConfigMaskWriteHeader(const pmConfig *config, psMetadata *header);
 
-bool pmConfigMaskSetBits(psMaskType *outMaskValue, psMaskType *outMarkValue, const pmConfig *config);
+bool pmConfigMaskSetBits(psImageMaskType *outMaskValue, psImageMaskType *outMarkValue, const pmConfig *config);
 
 #endif