Replace matchedRefDiff/ChiContext with pexConfig.ChoiceField

Author: taranu

pipelines/coaddDiffMatchedQualityExtended.yaml

@@ -8,53 +8,50 @@ tasks:
 
       # plots
       atools.matchedRefCModelMagDiffPlot: MatchedRefCoaddCModelFluxPlot
-      atools.matchedRefCModelMagDiffPlot.applyContext: MatchedRefDiffContext
+      atools.matchedRefCModelMagDiffPlot.context: 'diff'
 
       atools.matchedRefCModelFluxChiPlot: MatchedRefCoaddCModelFluxPlot
-      atools.matchedRefCModelFluxChiPlot.applyContext: MatchedRefChiContext
+      atools.matchedRefCModelFluxChiPlot.context: 'chi'
 
       # TODO: Can this be a one liner?
       atools.matchedRefPositionXDiffPlot: MatchedRefCoaddPositionPlot
-      # TODO: variable must be defined before applyContext; can this be enforced?
-      # (the resulting error if not is not very informative)
       atools.matchedRefPositionXDiffPlot.variable: x
-      atools.matchedRefPositionXDiffPlot.applyContext: MatchedRefDiffContext
+      atools.matchedRefPositionXDiffPlot.context: 'diff'
 
       atools.matchedRefPositionXChiPlot: MatchedRefCoaddPositionPlot
       atools.matchedRefPositionXChiPlot.variable: x
-      atools.matchedRefPositionXChiPlot.applyContext: MatchedRefChiContext
+      atools.matchedRefPositionXChiPlot.context: 'chi'
 
       atools.matchedRefPositionYDiffPlot: MatchedRefCoaddPositionPlot
       atools.matchedRefPositionYDiffPlot.variable: y
-      atools.matchedRefPositionYDiffPlot.applyContext: MatchedRefDiffContext
+      atools.matchedRefPositionYDiffPlot.context: 'diff'
 
       atools.matchedRefPositionYChiPlot: MatchedRefCoaddPositionPlot
       atools.matchedRefPositionYChiPlot.variable: y
-      atools.matchedRefPositionYChiPlot.applyContext: MatchedRefChiContext
+      atools.matchedRefPositionYChiPlot.context: 'chi'
 
       # metrics
       atools.matchedRefCModelMagDiffMetric: MatchedRefCoaddCModelFluxMetric
-      atools.matchedRefCModelMagDiffMetric.applyContext: MatchedRefDiffContext
+      atools.matchedRefCModelMagDiffMetric.context: 'diff'
 
       atools.matchedRefCModelFluxChiMetric: MatchedRefCoaddCModelFluxMetric
-      atools.matchedRefCModelFluxChiMetric.applyContext: MatchedRefChiContext
+      atools.matchedRefCModelFluxChiMetric.context: 'chi'
 
       atools.matchedRefPositionXDiffMetric: MatchedRefCoaddPositionMetric
       atools.matchedRefPositionXDiffMetric.variable: x
-      atools.matchedRefPositionXDiffMetric.applyContext: MatchedRefChiContext
+      atools.matchedRefPositionXDiffMetric.context: 'chi'
 
       atools.matchedRefPositionXChiMetric: MatchedRefCoaddPositionMetric
       atools.matchedRefPositionXChiMetric.variable: x
-      atools.matchedRefPositionXChiMetric.applyContext: MatchedRefChiContext
+      atools.matchedRefPositionXChiMetric.context: 'chi'
 
       atools.matchedRefPositionYDiffMetric: MatchedRefCoaddPositionMetric
       atools.matchedRefPositionYDiffMetric.variable: y
-      atools.matchedRefPositionYDiffMetric.applyContext: MatchedRefDiffContext
+      atools.matchedRefPositionYDiffMetric.context: 'diff'
 
       atools.matchedRefPositionYChiMetric: MatchedRefCoaddPositionMetric
       atools.matchedRefPositionYChiMetric.variable: y
-      atools.matchedRefPositionYChiMetric.applyContext: MatchedRefChiContext
-
+      atools.matchedRefPositionYChiMetric.context: 'chi'
 
       python: |
         from lsst.analysis.tools.atools.diffMatched import (
@@ -66,8 +63,3 @@ tasks:
           MatchedRefCoaddCModelFluxPlot,
           MatchedRefCoaddPositionPlot,
         )
-
-        from lsst.analysis.tools.contexts._contexts import (
-          MatchedRefDiffContext,
-          MatchedRefChiContext,
-        )

python/lsst/analysis/tools/atools/diffMatched.py

@@ -197,26 +197,30 @@ class MatchedRefCoaddDiffMagTool(MatchedRefCoaddToolBase):
     The default model flux is cModel.
     """
 
-    def matchedRefDiffContext(self):
-        self.process.buildActions.diff = SubtractVector(
-            actionA=MagColumnNanoJansky(
-                vectorKey=self.process.buildActions.fluxes_meas.vectorKey, returnMillimags=True
-            ),
-            actionB=DivideVector(
-                actionA=self.process.buildActions.mags_ref,
-                # To convert to mmag
-                actionB=ConstantValue(value=1e-3),
-            ),
-        )
-
-    def matchedRefChiContext(self):
-        self.process.buildActions.diff = DivideVector(
-            actionA=SubtractVector(
-                actionA=LoadVector(vectorKey=self.process.buildActions.fluxes_meas.vectorKey),
-                actionB=LoadVector(vectorKey=self.process.buildActions.fluxes_ref.vectorKey),
-            ),
-            actionB=LoadVector(vectorKey=f"{self.process.buildActions.fluxes_meas.vectorKey}Err"),
-        )
+    def finalize(self):
+        super().finalize()
+        if not hasattr(self.process.buildActions, "diff"):
+            if self.context == "diff":
+                self.process.buildActions.diff = SubtractVector(
+                    actionA=MagColumnNanoJansky(
+                        vectorKey=self.process.buildActions.fluxes_meas.vectorKey, returnMillimags=True
+                    ),
+                    actionB=DivideVector(
+                        actionA=self.process.buildActions.mags_ref,
+                        # To convert to mmag
+                        actionB=ConstantValue(value=1e-3),
+                    ),
+                )
+            elif self.context == "chi":
+                self.process.buildActions.diff = DivideVector(
+                    actionA=SubtractVector(
+                        actionA=LoadVector(vectorKey=self.process.buildActions.fluxes_meas.vectorKey),
+                        actionB=LoadVector(vectorKey=self.process.buildActions.fluxes_ref.vectorKey),
+                    ),
+                    actionB=LoadVector(vectorKey=f"{self.process.buildActions.fluxes_meas.vectorKey}Err"),
+                )
+            else:
+                raise ValueError(f"Unrecognized {self.context=}")
 
     def setDefaults(self):
         super().setDefaults()
@@ -237,20 +241,19 @@ def setDefaults(self):
 class MatchedRefCoaddCModelFluxMetric(MatchedRefCoaddDiffMagTool, MatchedRefCoaddMetric):
     """Metric for diffs between reference and CModel coadd mags."""
 
-    def matchedRefDiffContext(self):
-        super().matchedRefDiffContext()
-        self.unit = "mmag"
-        self.name_prefix = "photom_mag_cModelFlux_{name_class}_diff_"
-        self.produce.metric.units = self.configureMetrics()
-
-    def matchedRefChiContext(self):
-        super().matchedRefChiContext()
-        self.unit = ""
-        self.name_prefix = "photom_mag_cModelFlux_{name_class}_chi_"
-        self.produce.metric.units = self.configureMetrics()
-
-    def setDefaults(self):
-        super().setDefaults()
+    def finalize(self):
+        super().finalize()
+        if not hasattr(self.process.metric, "units"):
+            if self.context == "diff":
+                self.unit = "mmag"
+                self.name_prefix = "photom_mag_cModelFlux_{name_class}_diff_"
+                self.produce.metric.units = self.configureMetrics()
+            elif self.context == "chi":
+                self.unit = ""
+                self.name_prefix = "photom_mag_cModelFlux_{name_class}_chi_"
+                self.produce.metric.units = self.configureMetrics()
+            else:
+                raise ValueError(f"Unrecognized {self.context=}")
 
 
 class MatchedRefCoaddDiffPositionTool(MatchedRefCoaddToolBase):
@@ -265,30 +268,26 @@ class MatchedRefCoaddDiffPositionTool(MatchedRefCoaddToolBase):
         optional=False,
     )
 
-    # TODO: Determine if this can be put back into setDefaults w/o this:
-    # lsst.pex.config.config.FieldValidationError:
-    # Field 'process.buildActions.pos_meas.vectorKey' failed validation:
-    # Required value cannot be None
-    def _setPos(self):
-        self.process.buildActions.pos_meas = LoadVector(vectorKey=self.variable)
-        self.process.buildActions.pos_ref = LoadVector(vectorKey=f"refcat_{self.variable}")
-
-    def matchedRefDiffContext(self):
-        self._setPos()
-        self.process.buildActions.diff = SubtractVector(
-            actionA=self.process.buildActions.pos_meas,
-            actionB=self.process.buildActions.pos_ref,
-        )
-
-    def matchedRefChiContext(self):
-        self._setPos()
-        self.process.buildActions.diff = DivideVector(
-            actionA=SubtractVector(
-                actionA=self.process.buildActions.pos_meas,
-                actionB=self.process.buildActions.pos_ref,
-            ),
-            actionB=LoadVector(vectorKey=f"{self.process.buildActions.pos_meas.vectorKey}Err"),
-        )
+    def finalize(self):
+        super().finalize()
+        if not hasattr(self.process.buildActions, "pos_meas"):
+            self.process.buildActions.pos_meas = LoadVector(vectorKey=self.variable)
+            self.process.buildActions.pos_ref = LoadVector(vectorKey=f"refcat_{self.variable}")
+            if self.context == "diff":
+                self.process.buildActions.diff = SubtractVector(
+                    actionA=self.process.buildActions.pos_meas,
+                    actionB=self.process.buildActions.pos_ref,
+                )
+            elif self.context == "chi":
+                self.process.buildActions.diff = DivideVector(
+                    actionA=SubtractVector(
+                        actionA=self.process.buildActions.pos_meas,
+                        actionB=self.process.buildActions.pos_ref,
+                    ),
+                    actionB=LoadVector(vectorKey=f"{self.process.buildActions.pos_meas.vectorKey}Err"),
+                )
+            else:
+                raise ValueError(f"Unrecognized {self.context=}")
 
     def setDefaults(self):
         super().setDefaults()
@@ -307,20 +306,19 @@ def setDefaults(self):
 class MatchedRefCoaddPositionMetric(MatchedRefCoaddDiffPositionTool, MatchedRefCoaddMetric):
     """Metric for diffs between reference and base coadd centroids."""
 
-    def matchedRefDiffContext(self):
-        super().matchedRefDiffContext()
-        self.unit = "pix"
-        self.name_prefix = f"astrom_{self.variable}_{{name_class}}_diff_"
-        self.produce.metric.units = self.configureMetrics()
-
-    def matchedRefChiContext(self):
-        super().matchedRefChiContext()
-        self.unit = ""
-        self.name_prefix = f"astrom_{self.variable}_{{name_class}}_diff_"
-        self.produce.metric.units = self.configureMetrics()
-
-    def setDefaults(self):
-        super().setDefaults()
+    def finalize(self):
+        super().finalize()
+        if not hasattr(self.process.metric, "units"):
+            if self.context == "diff":
+                self.unit = "pix"
+                self.name_prefix = f"astrom_{self.variable}_{{name_class}}_diff_"
+                self.produce.metric.units = self.configureMetrics()
+            elif self.context == "chi":
+                self.unit = ""
+                self.name_prefix = f"astrom_{self.variable}_{{name_class}}_diff_"
+                self.produce.metric.units = self.configureMetrics()
+            else:
+                raise ValueError(f"Unrecognized {self.context=}")
 
 
 class MatchedRefCoaddPlot(AnalysisTool):
@@ -360,26 +358,24 @@ def setDefaults(self):
 
 
 class MatchedRefCoaddCModelFluxPlot(MatchedRefCoaddCModelPlot, MatchedRefCoaddDiffMagTool):
-    def matchedRefDiffContext(self):
-        super().matchedRefDiffContext()
-        self.produce.plot.yAxisLabel = "cModel - Reference mmag"
-
-    def matchedRefChiContext(self):
-        super().matchedRefChiContext()
-        self.produce.plot.yAxisLabel = "chi = (cModel - Reference mag)/error"
-
-    def setDefaults(self):
-        super().setDefaults()
+    def finalize(self):
+        MatchedRefCoaddCModelPlot(self).finalize()
+        MatchedRefCoaddDiffMagTool(self).finalize()
+        if self.context == "diff":
+            self.produce.plot.yAxisLabel = "cModel - Reference mmag"
+        elif self.context == "chi":
+            self.produce.plot.yAxisLabel = "chi = (cModel - Reference mag)/error"
+        else:
+            raise ValueError(f"Unrecognized {self.context=}")
 
 
 class MatchedRefCoaddPositionPlot(MatchedRefCoaddCModelPlot, MatchedRefCoaddDiffPositionTool):
-    def matchedRefDiffContext(self):
-        super().matchedRefDiffContext()
-        self.produce.plot.yAxisLabel = f"{self.variable} position (pix)"
-
-    def matchedRefChiContext(self):
-        super().matchedRefChiContext()
-        self.produce.plot.yAxisLabel = f"chi = (slot - Reference {self.variable} position)/error"
-
-    def setDefaults(self):
-        super().setDefaults()
+    def finalize(self):
+        MatchedRefCoaddCModelPlot(self).finalize()
+        MatchedRefCoaddDiffPositionTool(self).finalize()
+        if self.context == "diff":
+            self.produce.plot.yAxisLabel = f"{self.variable} position (pix)"
+        elif self.context == "chi":
+            self.produce.plot.yAxisLabel = f"chi = (slot - Reference {self.variable} position)/error"
+        else:
+            raise ValueError(f"Unrecognized {self.context=}")

python/lsst/analysis/tools/contexts/_contexts.py

@@ -24,18 +24,10 @@
 be a subclass of `Context`, and should contain a description of what the
 context is for as it's docstring.
 """
-__all__ = ("MatchedRefDiffContext", "MatchedRefChiContext")
+__all__ = ("ExampleContext",)
 
 from ._baseContext import Context
 
 
-class MatchedRefDiffContext(Context):
-    """A context which indicates `AnalysisAction`s are computing differences
-    between matches to reference objects.
-    """
-
-
-class MatchedRefChiContext(Context):
-    """A context which indicates `AnalysisAction`s are computing error-scaled
-    differences between matches to reference objects.
-    """
+class ExampleContext(Context):
+    """An example context which should not actually be used."""

tests/test_metrics.py

@@ -29,19 +29,17 @@
     MatchedRefCoaddMetric,
     MatchedRefCoaddPositionMetric,
 )
-from lsst.analysis.tools.contexts import MatchedRefChiContext, MatchedRefDiffContext
 
 
 class TestDiffMatched(TestCase):
     def setUp(self) -> None:
         super().setUp()
         self.band_default = "analysisTools"
-        self.contexts = (MatchedRefChiContext, MatchedRefDiffContext)
+        self.contexts = ("chi", "diff")
 
     def _testMatchedRefCoaddMetricDerived(self, type_metric: type[MatchedRefCoaddMetric], **kwargs):
         for context in self.contexts:
-            tester = type_metric(**kwargs)
-            tester.applyContext(context)
+            tester = type_metric(**kwargs, context=context)
             tester.finalize()
 
             keys = list(k[0] for k in tester.getInputSchema())