antares-devkit 0.10.0__tar.gz → 0.11.0__tar.gz

{antares_devkit-0.10.0 → antares_devkit-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: antares-devkit
-Version: 0.10.0
+Version: 0.11.0
 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.10.0 → antares_devkit-0.11.0}/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.11.0/antares_devkit/filters/simple_slsn_filter/__init__.py

@@ -0,0 +1,157 @@
+from antares_devkit.models import BaseFilter
+
+
+class SimpleSLSNPreFilter(BaseFilter):
+    """
+    Lightweight ZTF pre-filter for downstream SLSN candidate enrichment.
+
+    The filter keeps valid g/r/i photometry, identifies the brightest
+    observed point, applies a basic uncertainty cut, stores the peak
+    measurements, and tags the locus for downstream processing.
+
+    Host matching and redshift-based luminosity calculations are handled
+    outside ANTARES.
+    """
+
+    SLACK_CHANNEL = "#filter-simple-slsn-prefilter"
+    TRIGGERING_SURVEY = "ztf"
+
+    REQUIRED_LOCUS_PROPERTIES = []
+
+    REQUIRED_ALERT_PROPERTIES = [
+        "ant_mjd",
+        "ztf_magpsf",
+        "ztf_sigmapsf",
+        "ztf_fid",
+    ]
+
+    REQUIRED_TAGS = []
+
+    OUTPUT_LOCUS_PROPERTIES = [
+        {
+            "name": "eyoue_slsn_peak_apparent_mag",
+            "type": "float",
+            "description": "Brightest valid ZTF PSF magnitude.",
+        },
+        {
+            "name": "eyoue_slsn_peak_mag_error",
+            "type": "float",
+            "description": "Uncertainty of the brightest ZTF measurement.",
+        },
+        {
+            "name": "eyoue_slsn_peak_mjd",
+            "type": "float",
+            "description": "MJD of the brightest ZTF measurement.",
+        },
+        {
+            "name": "eyoue_slsn_peak_band",
+            "type": "str",
+            "description": "ZTF band of the brightest measurement.",
+        },
+        {
+            "name": "eyoue_slsn_prefilter_status",
+            "type": "str",
+            "description": "Result of the SLSN pre-filter.",
+        },
+    ]
+
+    OUTPUT_LOCUS_TAGS = [
+        {
+            "name": "eyoue_slsn_prefilter",
+            "description": (
+                "ZTF transient selected for downstream SLSN enrichment."
+            ),
+        },
+    ]
+
+    REQUIRES_FILES = []
+
+    def setup(self):
+        self.minimum_valid_detections = 3
+        self.maximum_peak_mag_error = 0.30
+        self.ztf_band_names = {1: "g", 2: "r", 3: "i"}
+
+    def _run(self, locus):
+        import numpy as np
+
+        def stop(reason):
+            locus.set_property("eyoue_slsn_prefilter_status", reason)
+            return None
+
+        try:
+            timeseries = locus.timeseries("ztf")
+
+            mjd = np.asarray(timeseries["ant_mjd"].data, dtype=float)
+            magnitudes = np.asarray(
+                timeseries["ztf_magpsf"].data,
+                dtype=float,
+            )
+            magnitude_errors = np.asarray(
+                timeseries["ztf_sigmapsf"].data,
+                dtype=float,
+            )
+            bands = np.asarray(
+                timeseries["ztf_fid"].data,
+                dtype=float,
+            )
+
+        except Exception:
+            return stop(
+                "Unable to evaluate: could not read required ZTF data"
+            )
+
+        valid = (
+            np.isfinite(mjd)
+            & np.isfinite(magnitudes)
+            & np.isfinite(magnitude_errors)
+            & (magnitude_errors > 0)
+            & np.isfinite(bands)
+            & np.isin(bands, [1.0, 2.0, 3.0])
+        )
+
+        if np.sum(valid) < self.minimum_valid_detections:
+            return stop("Rejected: too few valid ZTF measurements")
+
+        mjd = mjd[valid]
+        magnitudes = magnitudes[valid]
+        magnitude_errors = magnitude_errors[valid]
+        bands = bands[valid].astype(int)
+
+        peak_index = int(np.argmin(magnitudes))
+
+        peak_mag = float(magnitudes[peak_index])
+        peak_error = float(magnitude_errors[peak_index])
+        peak_mjd = float(mjd[peak_index])
+        peak_band = self.ztf_band_names.get(
+            int(bands[peak_index]),
+            "unknown",
+        )
+
+        locus.set_property(
+            "eyoue_slsn_peak_apparent_mag",
+            peak_mag,
+        )
+        locus.set_property(
+            "eyoue_slsn_peak_mag_error",
+            peak_error,
+        )
+        locus.set_property(
+            "eyoue_slsn_peak_mjd",
+            peak_mjd,
+        )
+        locus.set_property(
+            "eyoue_slsn_peak_band",
+            peak_band,
+        )
+
+        if peak_error > self.maximum_peak_mag_error:
+            return stop(
+                "Rejected: brightest measurement has excessive uncertainty"
+            )
+
+        locus.set_property(
+            "eyoue_slsn_prefilter_status",
+            "Passed pre-filter; requires downstream NED enrichment",
+        )
+
+        locus.tag("eyoue_slsn_prefilter")

{antares_devkit-0.10.0 → antares_devkit-0.11.0}/antares_devkit/utils.py

@@ -55,6 +55,7 @@ def get_filters_path():
         "LsstTransientQualityFilterScimma": "antares_devkit.filters.lsst_transient_quality_scimma",
         "UniformRandomSample": "antares_devkit.filters.uniform_random_sample",
         "Lantern": "antares_devkit.filters.lantern",
+        "SimpleSLSNPreFilter": "antares_devkit.filters.simple_slsn_filter",
     }
 
 

{antares_devkit-0.10.0 → antares_devkit-0.11.0}/pyproject.toml

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