Merge branch 'main' into tickets/DM-39697

pipelines/coaddDiffMatchedQualityExtended.yaml

@@ -7,67 +7,50 @@ tasks:
       connections.outputName: diff_matched_truth_summary_objectTable_tract
 
       # plots
-      atools.matchedRefCModelMagDiff: MatchedRefCoaddCModelFluxPlot
-      atools.matchedRefCModelMagDiff.applyContext: MatchedRefDiffContext
+      atools.matchedRefCModelMagDiff: MatchedRefCoaddDiffMagPlot
 
-      atools.matchedRefCModelFluxChi: MatchedRefCoaddCModelFluxPlot
-      atools.matchedRefCModelFluxChi.applyContext: MatchedRefChiContext
+      atools.matchedRefMagChi: MatchedRefCoaddDiffMagPlot
+      atools.matchedRefMagChi.compute_chi: true
 
       # TODO: Can this be a one liner?
-      atools.matchedRefPositionXDiff: MatchedRefCoaddPositionPlot
-      # TODO: variable must be defined before applyContext; can this be enforced?
-      # (the resulting error if not is not very informative)
+      atools.matchedRefPositionXDiff: MatchedRefCoaddDiffPositionPlot
       atools.matchedRefPositionXDiff.variable: x
-      atools.matchedRefPositionXDiff.applyContext: MatchedRefDiffContext
 
-      atools.matchedRefPositionXChi: MatchedRefCoaddPositionPlot
+      atools.matchedRefPositionXChi: MatchedRefCoaddDiffPositionPlot
       atools.matchedRefPositionXChi.variable: x
-      atools.matchedRefPositionXChi.applyContext: MatchedRefChiContext
+      atools.matchedRefPositionXChi.compute_chi: true
 
-      atools.matchedRefPositionYDiff: MatchedRefCoaddPositionPlot
+      atools.matchedRefPositionYDiff: MatchedRefCoaddDiffPositionPlot
       atools.matchedRefPositionYDiff.variable: y
-      atools.matchedRefPositionYDiff.applyContext: MatchedRefDiffContext
 
-      atools.matchedRefPositionYChi: MatchedRefCoaddPositionPlot
+      atools.matchedRefPositionYChi: MatchedRefCoaddDiffPositionPlot
       atools.matchedRefPositionYChi.variable: y
-      atools.matchedRefPositionYChi.applyContext: MatchedRefChiContext
+      atools.matchedRefPositionYChi.compute_chi: true
 
       # metrics
-      atools.matchedRefCModelMagDiffMetric: MatchedRefCoaddCModelFluxMetric
-      atools.matchedRefCModelMagDiffMetric.applyContext: MatchedRefDiffContext
+      atools.matchedRefCModelMagDiffMetric: MatchedRefCoaddDiffMagMetric
 
-      atools.matchedRefCModelFluxChiMetric: MatchedRefCoaddCModelFluxMetric
-      atools.matchedRefCModelFluxChiMetric.applyContext: MatchedRefChiContext
+      atools.matchedRefMagChiMetric: MatchedRefCoaddDiffMagMetric
+      atools.matchedRefMagChiMetric.compute_chi: true
 
-      atools.matchedRefPositionXDiffMetric: MatchedRefCoaddPositionMetric
+      atools.matchedRefPositionXDiffMetric: MatchedRefCoaddDiffPositionMetric
       atools.matchedRefPositionXDiffMetric.variable: x
-      atools.matchedRefPositionXDiffMetric.applyContext: MatchedRefDiffContext
 
-      atools.matchedRefPositionXChiMetric: MatchedRefCoaddPositionMetric
+      atools.matchedRefPositionXChiMetric: MatchedRefCoaddDiffPositionMetric
       atools.matchedRefPositionXChiMetric.variable: x
-      atools.matchedRefPositionXChiMetric.applyContext: MatchedRefChiContext
+      atools.matchedRefPositionXChiMetric.compute_chi: true
 
-      atools.matchedRefPositionYDiffMetric: MatchedRefCoaddPositionMetric
+      atools.matchedRefPositionYDiffMetric: MatchedRefCoaddDiffPositionMetric
       atools.matchedRefPositionYDiffMetric.variable: y
-      atools.matchedRefPositionYDiffMetric.applyContext: MatchedRefDiffContext
 
-      atools.matchedRefPositionYChiMetric: MatchedRefCoaddPositionMetric
+      atools.matchedRefPositionYChiMetric: MatchedRefCoaddDiffPositionMetric
       atools.matchedRefPositionYChiMetric.variable: y
-      atools.matchedRefPositionYChiMetric.applyContext: MatchedRefChiContext
-
+      atools.matchedRefPositionYChiMetric.compute_chi: true
 
       python: |
         from lsst.analysis.tools.atools.diffMatched import (
-          MatchedRefCoaddCModelFluxMetric,
-          MatchedRefCoaddPositionMetric,
-        )
-
-        from lsst.analysis.tools.atools.diffMatched import (
-          MatchedRefCoaddCModelFluxPlot,
-          MatchedRefCoaddPositionPlot,
-        )
-
-        from lsst.analysis.tools.contexts._contexts import (
-          MatchedRefDiffContext,
-          MatchedRefChiContext,
+          MatchedRefCoaddDiffMagMetric,
+          MatchedRefCoaddDiffPositionMetric,
+          MatchedRefCoaddDiffMagPlot,
+          MatchedRefCoaddDiffPositionPlot,
         )

pipelines/coaddQualityExtended.yaml

@@ -1,10 +1,32 @@
 description: |
-  Tier2 plots and metrics to assess coadd quality
+  Tier2 atools and metrics to assess coadd quality
 tasks:
   analyzeObjectTableExtended:
     class: lsst.analysis.tools.tasks.ObjectTableTractAnalysisTask
     config:
       connections.outputName: objectTableExtended
+      # set plots to run
       atools.ap12PsfSky: Ap12PsfSkyPlot
+      atools.shapeSizeDetRadiusVsCmodelMag: SizeMagnitudePlot
+      atools.shapeSizeDetRadiusVsCmodelMag.size_type: "determinantRadius"
+      atools.shapeSizeDetRadiusVsCmodelMag.mag_x: "cmodel_err"
+      atools.shapeSizeDetRadiusVsCmodelMag.size_y: "shape_slot"
+      atools.shapeSizeDetRadiusVsCmodelMag.applyContext: CoaddContext
+      atools.shapeSizeDetRadiusVsPsfMag: SizeMagnitudePlot
+      atools.shapeSizeDetRadiusVsPsfMag.size_type: "determinantRadius"
+      atools.shapeSizeDetRadiusVsPsfMag.mag_x: "psf_err"
+      atools.shapeSizeDetRadiusVsPsfMag.size_y: "shape_slot"
+      atools.shapeSizeDetRadiusVsPsfMag.applyContext: CoaddContext
+      atools.cModelBulgeSizeVsCmodelBulgeMag: SizeMagnitudePlot
+      atools.cModelBulgeSizeVsCmodelBulgeMag.size_type: "singleColumnSize"
+      atools.cModelBulgeSizeVsCmodelBulgeMag.mag_x: "bulge_err"
+      atools.cModelBulgeSizeVsCmodelBulgeMag.size_y: "bulge"
+      atools.cModelBulgeSizeVsCmodelBulgeMag.applyContext: CoaddContext
+      atools.cModelDiskSizeVsCmodelDiskMag: SizeMagnitudePlot
+      atools.cModelDiskSizeVsCmodelDiskMag.size_type: "singleColumnSize"
+      atools.cModelDiskSizeVsCmodelDiskMag.mag_x: "disk_err"
+      atools.cModelDiskSizeVsCmodelDiskMag.size_y: "disk"
+      atools.cModelDiskSizeVsCmodelDiskMag.applyContext: CoaddContext
       python: |
         from lsst.analysis.tools.atools import *
+        from lsst.analysis.tools.contexts import *

python/lsst/analysis/tools/actions/plot/scatterplotWithTwoHists.py

@@ -161,6 +161,8 @@ class ScatterPlotWithTwoHists(PlotAction):
     xAxisLabel = Field[str](doc="Label to use for the x axis", optional=False)
     yAxisLabel = Field[str](doc="Label to use for the y axis", optional=False)
     magLabel = Field[str](doc="Label to use for the magnitudes used for SNR", optional=False)
+
+    legendLocation = Field[str](doc="Legend position within main plot", default="upper left")
     nBins = Field[float](doc="Number of bins on x axis", default=40.0)
     plot2DHist = Field[bool](
         doc="Plot a 2D histogram in dense areas of points on the scatter plot."
@@ -652,7 +654,7 @@ def _scatterPlot(
             handles=linesForLegend,
             ncol=4,
             fontsize=6,
-            loc="upper left",
+            loc=self.legendLocation,
             framealpha=0.9,
             edgecolor="k",
             borderpad=0.4,

python/lsst/analysis/tools/actions/vector/__init__.py

@@ -1,6 +1,6 @@
 from .calcBinnedStats import *
+from .calcMomentSize import *
 from .calcRhoStatistics import *
-from .calcShapeSize import *
 from .ellipticity import *
 from .mathActions import *
 from .selectors import *

python/lsst/analysis/tools/actions/vector/calcBinnedStats.py

@@ -36,8 +36,8 @@
 
 class CalcBinnedStatsAction(KeyedDataAction):
     key_vector = Field[str](doc="Vector on which to compute statistics")
-    name_prefix = Field[str](doc="Field name to append stat names to")
-    name_suffix = Field[str](doc="Field name to append to stat names")
+    name_prefix = Field[str](default="", doc="Field name to append stat names to")
+    name_suffix = Field[str](default="", doc="Field name to append to stat names")
     selector_range = ConfigurableActionField[RangeSelector](doc="Range selector")
 
     def getInputSchema(self, **kwargs) -> KeyedDataSchema:

python/lsst/analysis/tools/actions/vector/calcShapeSize.py → python/lsst/analysis/tools/actions/vector/calcMomentSize.py

@@ -20,7 +20,7 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
-__all__ = ("CalcShapeSize",)
+__all__ = ("CalcMomentSize",)
 
 import numpy as np
 from lsst.pex.config import Field, FieldValidationError
@@ -29,25 +29,26 @@
 from ...interfaces import KeyedData, KeyedDataSchema, Vector, VectorAction
 
 
-class CalcShapeSize(VectorAction):
-    r"""Calculate a size: :math:`(I_{xx}I_{yy}-I_{xy}^2)^{\frac{1}{4}}`
-    (determinant radius) or :math:`\sqrt{(I_{xx}+I_{yy})/2}`
-    (trace radius).
+class CalcMomentSize(VectorAction):
+    r"""Calculate a size based on 2D moments.
+
+    Given a 2x2 matrix of moments (i.e. moment of inertia), two sizes can be
+    defined as follows:
+
+    Determinant radius: :math:`(I_{xx}I_{yy}-I_{xy}^2)^{\frac{1}{4}}`
+    Trace radius: :math:`\sqrt{(I_{xx}+I_{yy})/2}`
 
     The square of size measure is typically expressed either as the arithmetic
     mean of the eigenvalues of the moment matrix (trace radius) or as the
     geometric mean of the eigenvalues (determinant radius), which can be
-    specified using the `sizeType` parameter. Both of these measures give the
-    :math:`\sigma^2` parameter for a 2D Gaussian.
+    specified using the `sizeType` parameter. Both of these measures
+    correspond to the :math:`\sigma^2` parameter for a 2D Gaussian.
 
+    Notes
+    -----
     Since lensing preserves surface brightness, the determinant radius relates
     the magnification cleanly as it is derived from the area of isophotes, but
     have a slightly higher chance of being NaNs for noisy moment estimates.
-
-    Notes
-    -----
-    This is a size measurement used for doing QA on the ellipticity
-    of the sources.
     """
 
     colXx = Field[str](
@@ -91,12 +92,8 @@ def getInputSchema(self) -> KeyedDataSchema:
 
     def __call__(self, data: KeyedData, **kwargs) -> Vector:
         if self.sizeType == "trace":
-            size = np.power(
-                0.5
-                * (
-                    data[self.colXx.format(**kwargs)] + data[self.colYy.format(**kwargs)]  # type: ignore
-                ),  # type: ignore
-                0.5,
+            size = np.sqrt(
+                0.5 * (data[self.colXx.format(**kwargs)] + data[self.colYy.format(**kwargs)])  # type: ignore
             )
         else:
             size = np.power(

python/lsst/analysis/tools/actions/vector/calcRhoStatistics.py

@@ -34,7 +34,7 @@
 from lsst.pex.config import ChoiceField, Config, ConfigField, Field, FieldValidationError
 
 from ...interfaces import KeyedData, KeyedDataAction, Vector
-from .calcShapeSize import CalcShapeSize
+from .calcMomentSize import CalcMomentSize
 from .ellipticity import CalcE, CalcEDiff
 from .mathActions import FractionalDifference
 
@@ -385,13 +385,13 @@ def __call__(self, data: KeyedData, **kwargs) -> KeyedData:
         calcEDiff = CalcEDiff(colA=calcEMeas, colB=calcEpsf)
 
         calcSizeResidual = FractionalDifference(
-            actionA=CalcShapeSize(
+            actionA=CalcMomentSize(
                 colXx=self.colXx,
                 colYy=self.colYy,
                 colXy=self.colXy,
                 sizeType=self.sizeType,
             ),
-            actionB=CalcShapeSize(
+            actionB=CalcMomentSize(
                 colXx=self.colPsfXx,
                 colYy=self.colPsfYy,
                 colXy=self.colPsfXy,

python/lsst/analysis/tools/actions/vector/mathActions.py

@@ -24,8 +24,13 @@
     "ConstantValue",
     "AddVector",
     "SubtractVector",
-    "DivideVector",
     "MultiplyVector",
+    "DivideVector",
+    "SquareVector",
+    "SqrtVector",
+    "RaiseFromBaseVector",
+    "RaiseToPowerVector",
+    "Log10Vector",
     "FractionalDifference",
 )
 
@@ -116,6 +121,73 @@ def __call__(self, data: KeyedData, **kwargs) -> Vector:
         return vecA / vecB
 
 
+class SqrtVector(VectorAction):
+    """Calculate sqrt(A)"""
+
+    actionA = ConfigurableActionField(doc="Action which supplies vector A", dtype=VectorAction)
+
+    def getInputSchema(self) -> KeyedDataSchema:
+        yield from self.actionA.getInputSchema()  # type: ignore
+
+    def __call__(self, data: KeyedData, **kwargs) -> Vector:
+        vecA = self.actionA(data, **kwargs)  # type: ignore
+        return np.sqrt(vecA)
+
+
+class SquareVector(VectorAction):
+    """Calculate A**2"""
+
+    actionA = ConfigurableActionField(doc="Action which supplies vector A", dtype=VectorAction)
+
+    def getInputSchema(self) -> KeyedDataSchema:
+        yield from self.actionA.getInputSchema()  # type: ignore
+
+    def __call__(self, data: KeyedData, **kwargs) -> Vector:
+        vecA = self.actionA(data, **kwargs)  # type: ignore
+        return vecA * vecA
+
+
+class RaiseFromBaseVector(VectorAction):
+    """Calculate n**A"""
+
+    actionA = ConfigurableActionField(doc="Action which supplies vector A", dtype=VectorAction)
+    base = Field[float](doc="The base value to raise to the power of vector values")
+
+    def getInputSchema(self) -> KeyedDataSchema:
+        yield from self.actionA.getInputSchema()  # type: ignore
+
+    def __call__(self, data: KeyedData, **kwargs) -> Vector:
+        vecA = self.actionA(data, **kwargs)  # type: ignore
+        return self.base**vecA
+
+
+class RaiseToPowerVector(VectorAction):
+    """Calculate A**n"""
+
+    actionA = ConfigurableActionField(doc="Action which supplies vector A", dtype=VectorAction)
+    power = Field[float](doc="The power to raise the vector to")
+
+    def getInputSchema(self) -> KeyedDataSchema:
+        yield from self.actionA.getInputSchema()  # type: ignore
+
+    def __call__(self, data: KeyedData, **kwargs) -> Vector:
+        vecA = self.actionA(data, **kwargs)  # type: ignore
+        return vecA**self.power
+
+
+class Log10Vector(VectorAction):
+    """Calculate log10(A)"""
+
+    actionA = ConfigurableActionField(doc="Action which supplies vector A", dtype=VectorAction)
+
+    def getInputSchema(self) -> KeyedDataSchema:
+        yield from self.actionA.getInputSchema()  # type: ignore
+
+    def __call__(self, data: KeyedData, **kwargs) -> Vector:
+        vecA = self.actionA(data, **kwargs)  # type: ignore
+        return np.log10(vecA)
+
+
 class FractionalDifference(VectorAction):
     """Calculate (A-B)/B."""
 

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

@@ -5,7 +5,9 @@
 from .coveragePlots import *
 from .diffMatched import *
 from .fluxMetrics import *
+from .genericBuild import *
 from .genericPrep import *
+from .genericProduce import *
 from .limitingMagnitudeMetric import *
 from .magDiff import *
 from .numericalValidity import *
@@ -14,6 +16,7 @@
 from .seeingMetric import *
 from .shapes import *
 from .simpleDiaPlot import *
+from .sizeMagnitude import *
 from .skyFluxStatisticMetrics import *
 from .skyObject import *
 from .skySource import *