From 9f797e69020f871277242a5b4f25739b5ae722d6 Mon Sep 17 00:00:00 2001
From: Bruno Sanchez <bsanchez@cppm.in2p3.fr>
Date: Tue, 16 Apr 2024 21:42:27 +0200
Subject: [PATCH] Adding tests to reflect the new spatially sampled metric

---
 python/lsst/ap/verify/testPipeline.py | 37 +++++++++++++++++++++++++--
 tests/test_testPipeline.py            | 31 ++++++++++++++++++++--
 2 files changed, 64 insertions(+), 4 deletions(-)

diff --git a/python/lsst/ap/verify/testPipeline.py b/python/lsst/ap/verify/testPipeline.py
index fdbe9dbe..02d0b646 100644
--- a/python/lsst/ap/verify/testPipeline.py
+++ b/python/lsst/ap/verify/testPipeline.py
@@ -38,7 +38,8 @@
                                  DiaPipelineConfig, FilterDiaSourceCatalogConfig)
 from lsst.pipe.base import PipelineTask, Struct
 from lsst.ip.isr import IsrTaskConfig
-from lsst.ip.diffim import GetTemplateConfig, AlardLuptonSubtractConfig, DetectAndMeasureConfig
+from lsst.ip.diffim import (GetTemplateConfig, AlardLuptonSubtractConfig,
+                            DetectAndMeasureConfig, SpatiallySampledMetricsConfig)
 from lsst.pipe.tasks.characterizeImage import CharacterizeImageConfig
 from lsst.pipe.tasks.calibrate import CalibrateConfig
 from lsst.meas.transiNet import RBTransiNetConfig
@@ -432,7 +433,6 @@ def run(self, science, matchedTemplate, difference,
         """
         return Struct(subtractedMeasuredExposure=difference,
                       diaSources=afwTable.SourceCatalog(),
-                      spatiallySampledMetrics=astropy.table.Table(),
                       )
 
 
@@ -460,6 +460,39 @@ def run(self, diaSourceCat):
                       )
 
 
+class MockSpatiallySampledMetricsTask(PipelineTask):
+    """A do-nothing substitute for SpatiallySampledMetricsTask.
+    """
+    ConfigClass = SpatiallySampledMetricsConfig
+    _DefaultName = "notSpatiallySampledMetricsTask"
+
+    def run(self, science, matchedTemplate, template, difference, diaSources):
+        """Produce spatially sampled metrics
+
+        Parameters
+        ----------
+        science : `lsst.afw.image.ExposureF`
+            Science exposure that the template was subtracted from.
+        matchedTemplate : `lsst.afw.image.ExposureF`
+            Warped and PSF-matched template that was used produce the
+            difference image.
+        template : `lsst.afw.image.ExposureF`
+            Warped and non PSF-matched template that was used to produce
+            the difference image.
+        difference : `lsst.afw.image.ExposureF`
+            Result of subtracting template from the science image.
+        diaSources : `lsst.afw.table.SourceCatalog`
+                The catalog of detected sources.
+
+        Returns
+        -------
+        results : `lsst.pipe.base.Struct`
+            Results struct with components.
+        """
+
+        return Struct(spatiallySampledMetrics=astropy.table.Table())
+
+
 class MockRBTransiNetTask(PipelineTask):
     """A do-nothing substitute for RBTransiNetTask.
     """
diff --git a/tests/test_testPipeline.py b/tests/test_testPipeline.py
index 5430cd30..785644f4 100644
--- a/tests/test_testPipeline.py
+++ b/tests/test_testPipeline.py
@@ -38,7 +38,8 @@
 from lsst.ap.verify.testPipeline import MockIsrTask, MockCharacterizeImageTask, \
     MockCalibrateTask, MockGetTemplateTask, \
     MockAlardLuptonSubtractTask, MockDetectAndMeasureTask, MockTransformDiaSourceCatalogTask, \
-    MockRBTransiNetTask, MockDiaPipelineTask, MockFilterDiaSourceCatalogTask
+    MockRBTransiNetTask, MockDiaPipelineTask, MockFilterDiaSourceCatalogTask, \
+    MockSpatiallySampledMetricsTask
 
 
 class MockTaskTestSuite(unittest.TestCase):
@@ -254,7 +255,6 @@ def testMockDetectAndMeasureTask(self):
              "difference": self.visitId,
              "diaSources": self.visitId,
              "subtractedMeasuredExposure": self.visitId,
-             "spatiallySampledMetrics": self.visitId,
              })
         pipelineTests.runTestQuantum(task, self.butler, quantum, mockRun=False)
 
@@ -264,6 +264,33 @@ def testMockFilterDiaSourceCatalogTask(self):
         result = task.run(afwTable.SourceCatalog())
         pipelineTests.assertValidOutput(task, result)
 
+    def testMockSpatiallySampledMetricsTask(self):
+        task = MockSpatiallySampledMetricsTask()
+        result = task.run(
+            afwImage.ExposureF(),
+            afwImage.ExposureF(),
+            afwImage.ExposureF(),
+            afwImage.ExposureF(),
+            afwTable.SourceCatalog(),
+        )
+        pipelineTests.assertValidOutput(task, result)
+
+        self.butler.put(afwImage.ExposureF(), "calexp", self.visitId)
+        self.butler.put(afwImage.ExposureF(), "deepDiff_matchedExp", self.visitId)
+        self.butler.put(afwImage.ExposureF(), "deepDiff_templateExp", self.visitId)
+        self.butler.put(afwImage.ExposureF(), "deepDiff_differenceExp", self.visitId)
+        self.butler.put(afwTable.SourceCatalog(), "deepDiff_candidateDiaSrc", self.visitId)
+        quantum = pipelineTests.makeQuantum(
+            task, self.butler, self.visitId,
+            {"science": self.visitId,
+             "matchedTemplate": self.visitId,
+             "template": self.visitId,
+             "difference": self.visitId,
+             "diaSources": self.visitId,
+             "spatiallySampledMetrics": self.visitId,
+             })
+        pipelineTests.runTestQuantum(task, self.butler, quantum, mockRun=False)
+
     def testMockRBTransiNetTask(self):
         task = MockRBTransiNetTask()
         pipelineTests.assertValidInitOutput(task)