Deprecate NaiveDipoleCentroid and NaiveDipoleFlux

lsst · Apr 25, 2024 · e94c68f · e94c68f
1 parent 2e278b8
commit e94c68f
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 7 deletions.
diff --git a/include/lsst/ip/diffim/DipoleAlgorithms.h b/include/lsst/ip/diffim/DipoleAlgorithms.h
@@ -208,7 +208,9 @@ inline DipoleFluxAlgorithm::DipoleFluxAlgorithm(
 class that knows how to calculate centroids as a simple unweighted first
  * moment of the 3x3 region around the peaks
  */
-class NaiveDipoleFlux : public DipoleFluxAlgorithm {
+class [[deprecated(
+        "This algorithm is deprecated and will be removed after v28.")]]
+    NaiveDipoleFlux : public DipoleFluxAlgorithm {
 public:
 
     typedef DipoleFluxControl Control;
@@ -240,7 +242,9 @@ class NaiveDipoleFlux : public DipoleFluxAlgorithm {
 /**
  *  @brief Intermediate base class for algorithms that compute a centroid.
  */
-class NaiveDipoleCentroid : public DipoleCentroidAlgorithm {
+class [[deprecated(
+        "This algorithm is deprecated and will be removed after v28.")]]
+    NaiveDipoleCentroid : public DipoleCentroidAlgorithm {
 public:
 
     NaiveDipoleCentroid(Control const & ctrl, std::string const & name, afw::table::Schema & schema);

diff --git a/python/lsst/ip/diffim/__init__.py b/python/lsst/ip/diffim/__init__.py
@@ -43,7 +43,9 @@
 # automatically register ip_diffim Algorithms;
 # CENTROID_ORDER=0.0, FLUX_ORDER==2.0
 from lsst.meas.base import wrapSimpleAlgorithm
-wrapSimpleAlgorithm(NaiveDipoleCentroid, Control=DipoleCentroidControl, executionOrder=0.0)
-wrapSimpleAlgorithm(NaiveDipoleFlux, Control=DipoleFluxControl, executionOrder=2.0)
+wrapSimpleAlgorithm(NaiveDipoleCentroid, Control=DipoleCentroidControl, executionOrder=0.0,
+                    deprecated="Plugin 'NaiveDipoleCentroid' is deprecated and will be removed after v28.0")
+wrapSimpleAlgorithm(NaiveDipoleFlux, Control=DipoleFluxControl, executionOrder=2.0,
+                    deprecated="Plugin 'NaiveDipoleFlux' is deprecated and will be removed after v28.0")
 wrapSimpleAlgorithm(PsfDipoleFlux, Control=PsfDipoleFluxControl, executionOrder=2.0)
 
diff --git a/python/lsst/ip/diffim/dipoleAlgorithms.cc b/python/lsst/ip/diffim/dipoleAlgorithms.cc
@@ -102,6 +102,10 @@ void declareDipoleFluxAlgorithm(lsst::cpputils::python::WrapperCollection &wrapp
     });
 }
 
+// Hide deprecation warnings when building pybind11.
+// Remove these pragmas on DM-44030
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated"
 void declareNaiveDipoleFlux(lsst::cpputils::python::WrapperCollection &wrappers) {
     using PyNaiveDipoleFlux = py::class_<NaiveDipoleFlux, std::shared_ptr<NaiveDipoleFlux>, DipoleFluxAlgorithm>;
 
@@ -158,6 +162,10 @@ void wrapDipoleAlgorithms(lsst::cpputils::python::WrapperCollection &wrappers) {
     declarePsfDipoleFlux(wrappers);
 }
 
+// Stop hiding deprecation warnings when building pybind11.
+// Remove these pragmas on DM-44030
+#pragma GCC diagnostic pop
+
 }  // diffim
 }  // ip
 }  // lsst
diff --git a/python/lsst/ip/diffim/dipoleMeasurement.py b/python/lsst/ip/diffim/dipoleMeasurement.py
@@ -106,8 +106,6 @@ def setDefaults(self):
                         "base_PixelFlags",
                         "base_SkyCoord",
                         "base_PsfFlux",
-                        "ip_diffim_NaiveDipoleCentroid",
-                        "ip_diffim_NaiveDipoleFlux",
                         "ip_diffim_PsfDipoleFlux",
                         "ip_diffim_ClassificationDipole",
                         ]
@@ -116,7 +114,7 @@ def setDefaults(self):
         self.slots.modelFlux = None
         self.slots.gaussianFlux = None
         self.slots.shape = None
-        self.slots.centroid = "ip_diffim_NaiveDipoleCentroid"
+        self.slots.centroid = "ip_diffim_PsfDipoleFlux"
         self.doReplaceWithNoise = False
 
 

diff --git a/tests/test_dipole.py b/tests/test_dipole.py
@@ -131,6 +131,7 @@ def setUp(self):
         self.w, self.h = 100, 100  # size of image
         self.xc, self.yc = 50, 50  # location of center of dipole
 
+    # Remove this test on DM-44030
     def testNaiveDipoleCentroid(self):
         control = ipDiffim.DipoleCentroidControl()
         psf, psfSum, exposure, s = createDipole(self.w, self.h, self.xc, self.yc)
@@ -147,6 +148,7 @@ def testNaiveDipoleCentroid(self):
             except Exception:
                 self.fail()
 
+    # Remove this test on DM-44030
     def testNaiveDipoleFluxControl(self):
         psf, psfSum, exposure, s = createDipole(self.w, self.h, self.xc, self.yc)
         control = ipDiffim.DipoleFluxControl()