Add documentation of KeyMaps

lsst · Feb 16, 2024 · 200cb05 · 200cb05
1 parent 8af9567
commit 200cb05
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/include/lsst/meas/base/PixelFlags.h b/include/lsst/meas/base/PixelFlags.h
@@ -78,9 +78,10 @@ class PixelFlagsAlgorithm : public SimpleAlgorithm {
 
 private:
     Control _ctrl;
-    KeyMap _centerKeys;
-    KeyMap _centerAllKeys;
-    KeyMap _anyKeys;
+    // The afw Table Keys for the various fields we add to the schema on construction.
+    KeyMap _centerKeys;     // Keys for bits set anywhere within the 3x3 region around the centroid.
+    KeyMap _centerAllKeys;  // Keys for bits set on the entire 3x3 region around the centroid.
+    KeyMap _anyKeys;        // Keys for bits set anywhere in the footprint.
     afw::table::Key<afw::table::Flag> _generalFailureKey;
     afw::table::Key<afw::table::Flag> _offImageKey;
 };