antares-devkit 0.9.2__tar.gz → 0.10.1__tar.gz

{antares_devkit-0.9.2 → antares_devkit-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: antares-devkit
-Version: 0.9.2
+Version: 0.10.1
 Summary: Provides tools and utility methods to write and debug ANTARES filters with Python.
 Keywords: antares,devkit,filter development
 Author-Email: NSF NOIRLab ANTARES Team <antares@noirlab.edu>

{antares_devkit-0.9.2 → antares_devkit-0.10.1}/antares_devkit/filters/decam_shadow/__init__.py

@@ -66,8 +66,10 @@ class InDecamShadow(BaseFilter):
                                       -31.6796, -31.2712, -32.3313])
         shadow_hydra_ra = np.array([ 159.2305, 159.2126, 157.6973])
         shadow_hydra_dec = np.array([-27.5186, -25.3493, -29.1417])
-        shadow_all_ra = np.hstack((shadow_virgo_ra, shadow_antlia_ra, shadow_dorado_ra, shadow_fornax_ra, shadow_hydra_ra))
-        shadow_all_dec = np.hstack((shadow_virgo_dec, shadow_antlia_dec, shadow_dorado_dec, shadow_fornax_dec, shadow_hydra_dec))
+        shadow_eridanus_ra = np.array([55.049339, 54.624471, 51.571778, 56.208088, 53.810654])
+        shadow_eridanus_dec = np.array([-18.580044, -23.027472, -21.335166, -21.91065, -20.373759])
+        shadow_all_ra = np.hstack((shadow_virgo_ra, shadow_antlia_ra, shadow_dorado_ra, shadow_fornax_ra, shadow_hydra_ra, shadow_eridanus_ra))
+        shadow_all_dec = np.hstack((shadow_virgo_dec, shadow_antlia_dec, shadow_dorado_dec, shadow_fornax_dec, shadow_hydra_dec, shadow_eridanus_dec))
         field_centers = SkyCoord(ra=shadow_all_ra*u.deg, dec=shadow_all_dec*u.deg)
         c = SkyCoord(ra*u.deg, dec*u.deg, frame='icrs')
         sep = c.separation(field_centers)

{antares_devkit-0.9.2 → antares_devkit-0.10.1}/antares_devkit/filters/extragalactic/__init__.py

@@ -1,24 +1,21 @@
 """Description:
-This filter finds locus that falls within 1 arcsec of a source listed in the 2MASS extended source catalog, the NASA/IPAC Extragalactic Database, the NYU Value-Added Galaxy Catalog, the Sloan Digitized Sky Survey Galaxy catalog, and the Veron Catalog of Quasars & AGNs, and within a radius corresponding to respective semi-major axis for the Third Reference Catalog of bright galaxies. As new galaxy catalogs are added in ANTARES, we will update the filter accordingly.
+This filter finds locus that falls within 1 arcsec of a source listed in the 2MASS extended source catalog, 
+the NASA/IPAC Extragalactic Database, the NYU Value-Added Galaxy Catalog, the Sloan Digitized Sky Survey Galaxy catalog, 
+Milliquas, and the Veron Catalog of Quasars & AGNs, and within a radius corresponding to respective semi-major axis 
+for the Third Reference Catalog of bright galaxies. As new galaxy catalogs are added in ANTARES, we will update the filter accordingly.
 """
 
 from antares_devkit.models import BaseFilter
 
 
 class Extragalactic(BaseFilter):
-    # NAME = 'extragalactic' #for this default filter, name is same as its tag
     SLACK_CHANNEL = "#filter-extragalactic"
 
-    REQUIRED_LOCUS_PROPERTIES = [
-        "ztf_object_id",
-    ]
+    TRIGGERING_SURVEY = "all"
+    REQUIRED_LOCUS_PROPERTIES = []
 
     ## bare absolute minimum alert properties proving it's good to go
     REQUIRED_ALERT_PROPERTIES = [
-        "ztf_fid",
-        "ztf_magpsf",
-        "ztf_sigmapsf",
-        "ant_mjd",
         "ant_survey",
     ]
 
@@ -29,14 +26,22 @@ class Extragalactic(BaseFilter):
         },
     ]
 
-    # REQUIRES_FILES = []
-
     def _run(self, locus):
+        survey = locus.alert.properties["ant_survey"] 
         if (
-            locus.alert.properties["ant_survey"] != 1
+            survey == 2
         ):  # be sure we don't work with upper limits
             return
 
+        # remove SSOs
+        if survey == 1:
+            if locus.properties['ztf_ssnamenr'] != 'null':
+                return
+
+        if survey == 4:
+            if len(locus.properties['survey']['lsst']['ss_object_id']) != 0:
+                return
+            
         matching_catalog_names = locus.catalog_objects.keys()
 
         # These are the catalogs (Antares-based names) with extended sources
@@ -47,8 +52,10 @@ class Extragalactic(BaseFilter):
             "sdss_gals",
             "veron_agn_qso",
             "RC3",
+            "milliquas",
         ]
 
+
         if set(matching_catalog_names) & set(xsc_cats):
-            # print (f'Extragalctic hit!!! {alert_id} {ztf_object_id}')
             locus.tag("extragalactic")
+

{antares_devkit-0.9.2 → antares_devkit-0.10.1}/antares_devkit/models.py

@@ -21,6 +21,12 @@ SURVEYS = {
     "all": [1, 2, 3, 4],
 }
 
+PROPERTY_PREFIX = {
+    "ztf": "ztf_",
+    "decat": "decat_",
+    "lsst": "lsst_",
+}
+
 ES_FLOAT_MAX_VALUE = (2 - 2**-23) * 2**127
 ES_FLOAT_MIN_VALUE = -ES_FLOAT_MAX_VALUE
 
@@ -608,8 +614,12 @@ class DevKitLocus(BaseModel):
         if not isinstance(value, (str, float, int)):
             raise ValueError("Properties must be integer, string or float")
 
-        if isinstance(value, float) and (value<ES_FLOAT_MIN_VALUE or ES_FLOAT_MAX_VALUE<value):
-            raise ValueError(f"Value `{value}` must be greater than {ES_FLOAT_MIN_VALUE} and lower than {ES_FLOAT_MAX_VALUE}")
+        if isinstance(value, float) and (
+            value < ES_FLOAT_MIN_VALUE or ES_FLOAT_MAX_VALUE < value
+        ):
+            raise ValueError(
+                f"Value `{value}` must be greater than {ES_FLOAT_MIN_VALUE} and lower than {ES_FLOAT_MAX_VALUE}"
+            )
 
         self.user_properties[key] = value
 
@@ -707,8 +717,19 @@ class BaseFilter(abc.ABC):
         return True
 
     def _satisfies_alert_contraints(self, alert: DevkitAlert) -> bool:
+        is_ztf_alert = alert.properties["ant_survey"] in SURVEYS["ztf"]
+        is_lsst_alert = alert.properties["ant_survey"] in SURVEYS["lsst"]
+        is_decat_alert = alert.properties["ant_survey"] in SURVEYS["decat"]
         for prop in self.REQUIRED_ALERT_PROPERTIES:
-            if prop not in alert.properties:
+            # if the required prop is survey specific and it doesn't match the survey
+            # for this alert then simply ignore that required prop.
+            if not is_lsst_alert and prop.startswith(PROPERTY_PREFIX["lsst"]):
+                continue
+            elif not is_ztf_alert and prop.startswith(PROPERTY_PREFIX["ztf"]):
+                continue
+            elif not is_decat_alert and prop.startswith(PROPERTY_PREFIX["decat"]):
+                continue
+            elif prop not in alert.properties:
                 return False
         if max_level := self.REQUIRED_GRAV_WAVE_PROB_REGION:
             matches = [

{antares_devkit-0.9.2 → antares_devkit-0.10.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "antares-devkit"
-version = "0.9.2"
+version = "0.10.1"
 description = "Provides tools and utility methods to write and debug ANTARES filters with Python."
 readme = "README.md"
 requires-python = ">=3.9"

antares_devkit-0.10.1/test/unit/antares_devkit/filters/test_test_dev_all.py

@@ -0,0 +1,171 @@
+import copy
+from test.data.large_locus import d as large_locus_dict
+
+import pytest
+
+from antares_devkit.filters.test_dev_all import TestDevAll
+from antares_devkit.models import DevKitLocus
+
+
+class TestTestDevAll:
+    def setup_method(self):
+        self._filter = TestDevAll()
+
+    def test_filter_should_be_skipped_when_required_alert_properties_not_satisfied(
+        self,
+    ):
+        locus_dict_copy = copy.deepcopy(large_locus_dict)
+        alert = locus_dict_copy["alerts"][-1]
+        # Change triggering alert to have no magnitude
+        alert["properties"].pop("ant_mag")
+
+        locus = DevKitLocus.model_validate(locus_dict_copy)
+        filter_returned = self._filter.run(locus)
+        assert filter_returned.status == "Skipped"
+
+    def test_filter_should_succeed_when_required_alert_properties_satisfied(
+        self,
+    ):
+        locus_dict_copy = copy.deepcopy(large_locus_dict)
+        alert = locus_dict_copy["alerts"][-1]
+        # force the ant_mag property to be set. This is a required prop for
+        # the TestDevAll filter
+        alert["properties"]["ant_mag"] = 1234
+        # ensure that the filter succeeds since the required alert prop is
+        # present
+        locus = DevKitLocus.model_validate(locus_dict_copy)
+        filter_returned = self._filter.run(locus)
+        assert filter_returned.status == "Succeeded"
+
+    def test_filter_should_succeed_when_no_required_alert_props_are_defined(
+        self,
+    ):
+        locus_dict_copy = copy.deepcopy(large_locus_dict)
+        alert = locus_dict_copy["alerts"][-1]
+        test_filter = TestDevAll()
+        test_filter.REQUIRED_ALERT_PROPERTIES = []
+        locus = DevKitLocus.model_validate(locus_dict_copy)
+        filter_returned = test_filter.run(locus)
+        assert filter_returned.status == "Succeeded"
+
+    def test_should_be_skipped_when_many_required_alert_properties_not_satisfied(self):
+        """
+        When a survey specific required prop is present but doesn't match survey
+        and a general one is not satisfied the filter should still be skipped.
+        This ensures survey specific property logic doesn't interfere with general
+        required properties.
+        """
+        locus_dict_copy = copy.deepcopy(large_locus_dict)
+        alert = locus_dict_copy["alerts"][-1]
+        # Change triggering alert to have no magnitude
+        alert["properties"].pop("ant_mag")
+        # Change triggering alert to be an ZTF
+        alert["properties"]["ant_survey"] = 1
+        # Add a survey specific required property that doesn't match the survey
+        test_filter = TestDevAll()
+        test_filter.REQUIRED_ALERT_PROPERTIES = (
+            test_filter.REQUIRED_ALERT_PROPERTIES + ["lsst_diaSource_diaSourceId"]
+        )
+        locus = DevKitLocus.model_validate(locus_dict_copy)
+        filter_returned = test_filter.run(locus)
+        assert filter_returned.status == "Skipped"
+
+    @pytest.mark.parametrize(
+        "ant_survey,missing_alert_prop,present_alert_prop,expected_status",
+        [
+            (
+                1,
+                "lsst_diaSource_diaSourceId",
+                {"ztf_object_id": "ztf:123456"},
+                "Succeeded",
+            ),
+            (3, "ztf_object_id", {"decat_object_id": "123456"}, "Succeeded"),
+            (4, "ztf_object_id", {"lsst_diaSource_diaSourceId": "123456"}, "Succeeded"),
+            (1, "ztf_object_id", {"lsst_diaSource_diaSourceId": "123456"}, "Skipped"),
+            (3, "decat_object_id", {"ztf_object_id": "123456"}, "Skipped"),
+            (
+                4,
+                "lsst_diaSource_diaSourceId",
+                {"ztf_object_id": "ztf:123456"},
+                "Skipped",
+            ),
+        ],
+    )
+    def test_should_only_skip_if_required_prop_matches_survey(
+        self, ant_survey, missing_alert_prop, present_alert_prop, expected_status
+    ):
+        # Initialize a special filter that requires both ZTF and LSST props
+        test_filter = TestDevAll()
+        test_filter.REQUIRED_ALERT_PROPERTIES = [
+            "lsst_diaSource_diaSourceId",
+            "ztf_object_id",
+            "decat_object_id",
+        ]
+        # copy a locus and retrieve one alert
+        locus_dict_copy = copy.deepcopy(large_locus_dict)
+        alert = locus_dict_copy["alerts"][-1]
+        # Change triggering alert survey
+        alert["properties"]["ant_survey"] = ant_survey
+        # remove the prop that should be missing
+        if missing_alert_prop in alert["properties"]:
+            alert["properties"].pop(missing_alert_prop)
+        # add the prop that should be populated
+        alert["properties"] |= present_alert_prop
+        # Run the filter and ensure the status is as expected
+        locus = DevKitLocus.model_validate(locus_dict_copy)
+        filter_returned = test_filter.run(locus)
+        assert filter_returned.status == expected_status
+
+    @pytest.mark.parametrize(
+        "survey_name,ant_survey",
+        [("ZTF candidate", 1), ("ZTF upper limit", 2), ("DECAT", 3), ("LSST", 4)],
+    )
+    def test_filter_should_succeed_with_alerts_from_any_survey(
+        self,
+        survey_name,
+        ant_survey,
+    ):
+        # {survey_name} case (variable not used, just descriptive of the case)
+        locus_dict_copy = copy.deepcopy(large_locus_dict)
+        alert = locus_dict_copy["alerts"][-1]
+        # Change triggering alert to be {survey_name}
+        alert["properties"]["ant_survey"] = ant_survey
+        locus = DevKitLocus.model_validate(locus_dict_copy)
+        filter_returned = self._filter.run(locus)
+        assert filter_returned.status == "Succeeded"
+
+    @pytest.mark.parametrize(
+        "ant_survey,ant_mag",
+        [(1, 16.4), (2, 15.2), (3, 19.5), (4, 19.9)],
+    )
+    def test_filter_should_add_tag_if_max_mag_not_reached(
+        self,
+        ant_survey,
+        ant_mag,
+    ):
+        locus_dict_copy = copy.deepcopy(large_locus_dict)
+        alert = locus_dict_copy["alerts"][-1]
+        alert["properties"]["ant_survey"] = ant_survey
+        alert["properties"]["ant_mag"] = ant_mag
+
+        locus = DevKitLocus.model_validate(large_locus_dict)
+        self._filter.run(locus)
+        assert self._filter.OUTPUT_LOCUS_TAGS[0]["name"] in locus.tags
+
+    @pytest.mark.parametrize(
+        "ant_survey,ant_mag",
+        [(1, 20), (2, 24.2), (3, 20.1), (4, 31.5)],
+    )
+    def test_filter_should_not_add_tag_if_max_mag_reached(
+        self,
+        ant_survey,
+        ant_mag,
+    ):
+        locus_dict_copy = copy.deepcopy(large_locus_dict)
+        alert = locus_dict_copy["alerts"][-1]
+        alert["properties"]["ant_survey"] = ant_survey
+        alert["properties"]["ant_mag"] = ant_mag
+
+        locus = DevKitLocus.model_validate(locus_dict_copy)
+        self._filter.run(locus)
+        assert self._filter.OUTPUT_LOCUS_TAGS[0]["name"] not in locus.tags

antares_devkit-0.9.2/test/unit/antares_devkit/filters/test_test_dev_all.py

@@ -1,78 +0,0 @@
-import copy
-from test.data.large_locus import d as large_locus_dict
-
-import pytest
-
-from antares_devkit.filters.test_dev_all import TestDevAll
-from antares_devkit.models import DevKitLocus
-
-
-class TestTestDevAll:
-    def setup_method(self):
-        self._filter = TestDevAll()
-
-    def test_filter_should_be_skipped_when_required_alert_properties_not_satisfied(
-        self,
-    ):
-        locus_dict_copy = copy.deepcopy(large_locus_dict)
-        alert = locus_dict_copy["alerts"][-1]
-        # Change triggering alert to have no magnitude
-        alert["properties"].pop("ant_mag")
-
-        locus = DevKitLocus.model_validate(locus_dict_copy)
-        filter_returned = self._filter.run(locus)
-        assert filter_returned.status == "Skipped"
-
-    @pytest.mark.parametrize(
-        "survey_name,ant_survey",
-        [("ZTF candidate", 1), ("ZTF upper limit", 2), ("DECAT", 3), ("LSST", 4)],
-    )
-    def test_filter_should_succeed_with_alerts_from_any_survey(
-        self,
-        survey_name,
-        ant_survey,
-    ):
-        # {survey_name} case (variable not used, just descriptive of the case)
-        locus_dict_copy = copy.deepcopy(large_locus_dict)
-        alert = locus_dict_copy["alerts"][-1]
-        # Change triggering alert to be {survey_name}
-        alert["properties"]["ant_survey"] = ant_survey
-        locus = DevKitLocus.model_validate(locus_dict_copy)
-        filter_returned = self._filter.run(locus)
-        assert filter_returned.status == "Succeeded"
-
-    @pytest.mark.parametrize(
-        "ant_survey,ant_mag",
-        [(1, 16.4), (2, 15.2), (3, 19.5), (4, 19.9)],
-    )
-    def test_filter_should_add_tag_if_max_mag_not_reached(
-        self,
-        ant_survey,
-        ant_mag,
-    ):
-        locus_dict_copy = copy.deepcopy(large_locus_dict)
-        alert = locus_dict_copy["alerts"][-1]
-        alert["properties"]["ant_survey"] = ant_survey
-        alert["properties"]["ant_mag"] = ant_mag
-
-        locus = DevKitLocus.model_validate(large_locus_dict)
-        self._filter.run(locus)
-        assert self._filter.OUTPUT_LOCUS_TAGS[0]["name"] in locus.tags
-
-    @pytest.mark.parametrize(
-        "ant_survey,ant_mag",
-        [(1, 20), (2, 24.2), (3, 20.1), (4, 31.5)],
-    )
-    def test_filter_should_not_add_tag_if_max_mag_reached(
-        self,
-        ant_survey,
-        ant_mag,
-    ):
-        locus_dict_copy = copy.deepcopy(large_locus_dict)
-        alert = locus_dict_copy["alerts"][-1]
-        alert["properties"]["ant_survey"] = ant_survey
-        alert["properties"]["ant_mag"] = ant_mag
-
-        locus = DevKitLocus.model_validate(locus_dict_copy)
-        self._filter.run(locus)
-        assert self._filter.OUTPUT_LOCUS_TAGS[0]["name"] not in locus.tags