Merge pull request #134 from lsst-sitcom/tickets/DM-47888

DM-47888: Add bandpass corrections for ComCam and rename function to be accurate

Author: mfisherlevine

python/lsst/summit/utils/utils.py

@@ -33,6 +33,7 @@
 from astropy.coordinates.earth import EarthLocation
 from astropy.time import Time
 from dateutil.tz import gettz
+from deprecated.sphinx import deprecated
 from matplotlib.patches import Rectangle
 from scipy.ndimage import gaussian_filter
 
@@ -85,7 +86,8 @@
     "obsInfoToDict",
     "getFieldNameAndTileNumber",
     "getAirmassSeeingCorrection",
-    "getFilterSeeingCorrection",
+    "getFilterSeeingCorrection",  # deprecated
+    "getBandpassSeeingCorrection",
     "getCdf",
     "getQuantiles",
     "digitizeData",
@@ -975,9 +977,34 @@ def getAirmassSeeingCorrection(airmass: float) -> float:
     return airmass ** (-0.6)
 
 
+@deprecated(
+    reason=". Will be removed after v28.0.",
+    version="v27.0",
+    category=FutureWarning,
+)
 def getFilterSeeingCorrection(filterName: str) -> float:
     """Get the correction factor for seeing due to a filter.
 
+    Parameters
+    ----------
+    filterName : `str`
+        The name of the filter, e.g. 'SDSSg_65mm'.
+
+    Returns
+    -------
+    correctionFactor : `float`
+        The correction factor to apply to the seeing.
+
+    Raises
+    ------
+        ValueError raised for unknown filters.
+    """
+    return getBandpassSeeingCorrection(filterName)
+
+
+def getBandpassSeeingCorrection(filterName: str) -> float:
+    """Get the correction factor for seeing due to a filter.
+
     Parameters
     ----------
     filterName : `str`
@@ -993,16 +1020,28 @@ def getFilterSeeingCorrection(filterName: str) -> float:
         ValueError raised for unknown filters.
     """
     match filterName:
-        case "SDSSg_65mm":
+        case "SDSSg_65mm":  # LATISS
             return (474.41 / 500.0) ** 0.2
-        case "SDSSr_65mm":
+        case "SDSSr_65mm":  # LATISS
             return (628.47 / 500.0) ** 0.2
-        case "SDSSi_65mm":
+        case "SDSSi_65mm":  # LATISS
             return (769.51 / 500.0) ** 0.2
-        case "SDSSz_65mm":
+        case "SDSSz_65mm":  # LATISS
             return (871.45 / 500.0) ** 0.2
-        case "SDSSy_65mm":
+        case "SDSSy_65mm":  # LATISS
             return (986.8 / 500.0) ** 0.2
+        case "u_02":  # ComCam
+            return (370.697 / 500.0) ** 0.2
+        case "g_01":  # ComCam
+            return (476.359 / 500.0) ** 0.2
+        case "r_03":  # ComCam
+            return (619.383 / 500.0) ** 0.2
+        case "i_06":  # ComCam
+            return (754.502 / 500.0) ** 0.2
+        case "z_03":  # ComCam
+            return (866.976 / 500.0) ** 0.2
+        case "y_04":  # ComCam
+            return (972.713 / 500.0) ** 0.2
         case _:
             raise ValueError(f"Unknown filter name: {filterName}")
 

tests/test_utils.py

@@ -42,18 +42,19 @@
 from lsst.obs.base.makeRawVisitInfoViaObsInfo import MakeRawVisitInfoViaObsInfo
 from lsst.obs.lsst import Latiss
 from lsst.obs.lsst.translators.latiss import AUXTEL_LOCATION
+from lsst.summit.utils.utils import getFilterSeeingCorrection  # deprecated
 from lsst.summit.utils.utils import (
     calcEclipticCoords,
     computeCcdExposureId,
     computeExposureId,
     fluxesFromFootprints,
     getAirmassSeeingCorrection,
+    getBandpassSeeingCorrection,
     getCurrentDayObs_datetime,
     getCurrentDayObs_humanStr,
     getCurrentDayObs_int,
     getExpPositionOffset,
     getFieldNameAndTileNumber,
-    getFilterSeeingCorrection,
     getQuantiles,
     quickSmooth,
 )
@@ -189,7 +190,24 @@ def test_getAirmassSeeingCorrection(self):
 
     def test_getFilterSeeingCorrection(self):
         for filterName in ("SDSSg_65mm", "SDSSr_65mm", "SDSSi_65mm"):
-            correction = getFilterSeeingCorrection(filterName)
+            with self.assertWarns(FutureWarning):
+                correction = getFilterSeeingCorrection(filterName)
+            self.assertGreater(correction, 0.5)
+            self.assertLess(correction, 1.5)
+
+    def test_getBandpassSeeingCorrection(self):
+        for filterName in (
+            "SDSSg_65mm",
+            "SDSSr_65mm",
+            "SDSSi_65mm",
+            "u_02",
+            "g_01",
+            "r_03",
+            "i_06",
+            "z_03",
+            "y_04",
+        ):
+            correction = getBandpassSeeingCorrection(filterName)
             self.assertGreater(correction, 0.5)
             self.assertLess(correction, 1.5)