antares-devkit 0.6.3__tar.gz → 0.6.4__tar.gz

{antares_devkit-0.6.3 → antares_devkit-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: antares-devkit
-Version: 0.6.3
+Version: 0.6.4
 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.6.4/antares_devkit/filters/lsst_transient_quality_scimma/__init__.py

@@ -0,0 +1,92 @@
+"""
+ANTARES filter for selecting high-quality LSST transient candidates
+for cross matching against Gaia and other catalogs using LSDB
+running in SCiMMA infrastructure. See https://scimma.org/
+
+This filter runs inside ANTARES infrastructure. It evaluates each incoming
+LSST alert against quality criteria and tags passing alerts for downstream
+crossmatching against catalogs.
+"""
+
+from antares_devkit.models import BaseFilter
+
+
+class LsstTransientQualityFilterScimma(BaseFilter):
+    """
+    This filter finds loci where the first alert has a SNR > 10 and the
+    image is not saturated, near an image edge, not classified as a dipole,
+    and excludes known solar system objects.
+    """
+
+    SLACK_CHANNEL = "#filter-scimma-lsst-quality"
+
+    TRIGGERING_SURVEY = "lsst"
+
+    REQUIRED_LOCUS_PROPERTIES = []
+
+    REQUIRED_ALERT_PROPERTIES = [
+        "lsst_diaSource_snr",
+        "lsst_diaSource_ssObjectId",
+        "lsst_diaSource_psfFlux_flag",
+        "lsst_diaSource_centroid_flag",
+        "lsst_diaSource_shape_flag",
+        "lsst_diaSource_isDipole",
+        "lsst_diaSource_pixelFlags_saturated",
+        "lsst_diaSource_pixelFlags_edge",
+        "lsst_diaSource_pixelFlags_cr",
+        "lsst_diaSource_pixelFlags_streak",
+    ]
+
+    REQUIRED_TAGS = []
+
+    REQUIRES_FILES = []
+
+    OUTPUT_TAG = "lsst_scimma_quality_transient"
+
+    OUTPUT_LOCUS_PROPERTIES = []
+
+    OUTPUT_LOCUS_TAGS = [
+        {
+            "name": OUTPUT_TAG,
+            "description": (
+                "LSST alert passes quality cuts for transient candidate "
+                "crossmatching by SCiMMA: SNR > 10, no quality flags, "
+                "not a known solar system object."
+            ),
+        },
+    ]
+
+    def setup(self):
+        pass
+
+    def _run(self, locus):
+        props = locus.alerts[-1].properties
+
+        # SNR must be strictly greater than 10.
+        if not props["lsst_diaSource_snr"] > 10:
+            return
+
+        # Exclude known solar system objects. The type of ssObjectId is
+        # not yet confirmed, so check for integer 0, None, and string "0".
+        if props["lsst_diaSource_ssObjectId"] not in (0, None, "0"):
+            return
+
+        # Quality flags must all be falsy.
+        if props["lsst_diaSource_psfFlux_flag"]:
+            return
+        if props["lsst_diaSource_centroid_flag"]:
+            return
+        if props["lsst_diaSource_shape_flag"]:
+            return
+        if props["lsst_diaSource_isDipole"]:
+            return
+        if props["lsst_diaSource_pixelFlags_saturated"]:
+            return
+        if props["lsst_diaSource_pixelFlags_edge"]:
+            return
+        if props["lsst_diaSource_pixelFlags_cr"]:
+            return
+        if props["lsst_diaSource_pixelFlags_streak"]:
+            return
+
+        locus.tag(self.OUTPUT_TAG)

antares_devkit-0.6.4/antares_devkit/filters/shadow_virgo/__init__.py

@@ -0,0 +1,50 @@
+"""Description
+This filter finds locus located within a radius of 1.1 deg from the center of the Shadow Project's Virgo Pointings.
+"""
+from antares_devkit.models import BaseFilter
+
+class InShadowVirgo(BaseFilter):
+    NAME = 'in_shadow_virgo' #for this default filter, name is same as its tag
+
+    SLACK_CHANNEL = "#filter-in-shadow-virgo"
+
+    ## bare absolute minimum alert properties proving it's good to go
+    REQUIRED_ALERT_PROPERTIES = [
+        'ant_ra',
+        'ant_dec',
+        'ant_survey'
+    ]
+
+    OUTPUT_TAGS = [
+        {
+            'name': 'in_virgo_shadow',
+            'description': 'Locus is along the line of sight to the Virgo fields covered by the DECam Shadow Project',
+        }
+    ]
+
+    def _run(self, locus):
+        import numpy as np
+        from astropy import units as u
+        from astropy.coordinates import SkyCoord
+
+        if locus.alert.properties['ant_survey'] == 2: #be sure we don't work with upper limits
+            return
+
+        ra = locus.alert.properties['ant_ra']
+        dec = locus.alert.properties['ant_dec']
+        #https://github.com/lsstshadow/shadowpointings/tree/main
+        shadow_virgo_ra = np.array([187.7014, 186.0754, 187.9486, 189.4263, 189.1219, 187.4805, 
+                                    185.9601, 187.6007, 186.0131, 184.8111, 184.3502, 183.9883, 
+                                    184.4658, 186.3005, 191.0718, 190.5631, 189.1516, 188.7788, 
+                                    186.6354, 185.6507, 182.4151, 193.2665, 189.5427, 190.6638, 
+                                    193.4287, 188.2634, 185.2524, 188.0598, 193.0875, 191.0943])
+        shadow_virgo_dec = np.array([12.3963,  13.4965,  14.307,   13.3041,  11.295,   10.4477, 
+                                     11.6469,   8.4389,   7.1655,   5.7578,  12.8014,   7.6415,
+                                     14.6628,  15.364,   12.0456,  10.0351,   8.9448,   6.8992, 
+                                      5.3375,   8.9489,  13.7313,   8.2527,   4.8363,   2.8801, 
+                                      1.8786,   2.356,    3.7762,   0.1955,  -1.1488,  -0.0399])
+        field_centers = SkyCoord(ra=shadow_virgo_ra*u.deg, dec=shadow_virgo_dec*u.deg)
+        c = SkyCoord(ra*u.deg, dec*u.deg, frame='icrs')
+        sep = c.separation(field_centers)
+        if (sep.deg < 1.1).any(): #DECam FOV = 2.2 deg diameter
+            locus.tag('in_shadow_virgo')

{antares_devkit-0.6.3 → antares_devkit-0.6.4}/antares_devkit/filters/young_rubin_transients_soraisam/__init__.py

@@ -1,10 +1,8 @@
-## v2
+## production version
 from antares_devkit.models import BaseFilter
 
-
 class young_rubin_transients_soraisam(BaseFilter):
-    ## MS: this is mainly for the NOIRLab end-to-end demonstration
-    
+        
     TRIGGERING_SURVEY = "lsst"
 
     SLACK_CHANNEL = "#filter-young-rubin-transients"
@@ -76,15 +74,19 @@ class young_rubin_transients_soraisam(BaseFilter):
         if 'lsst' in locus.properties['survey'].keys():
             if len(locus.properties['survey']['lsst']['dia_object_id']) > 1:
                 C0 = True 
+        # print ("C0", C0)
         if C0:
             return
+
         
-        
-        C1 = (locus.alert.properties['lsst_diaSource_reliability'] < 0.9)
+        C1 = (locus.alert.properties['lsst_diaSource_reliability'] < 0.8)
+        # print ("C1", C1, locus.alert.properties['lsst_diaSource_reliability'])
         if C1:
             return
+        
 
         C2 = (locus.alert.properties['lsst_diaSource_ssObjectId'] != 0)
+        # print ("C2", C2)
         if C2:
             return
 
@@ -95,28 +97,30 @@ class young_rubin_transients_soraisam(BaseFilter):
         current_pb = locus.alert.properties['ant_passband']
         
         # ## confirm locus is extragalactic 
+        C3 = True
         astro_objects = locus.catalog_objects
-        # matching_catalog_names = astro_objects.keys()
-        # # Below is a battle-tested set of extended source catalogs (Antares-based names)
-        # xsc_cats = [
-        #     "2mass_xsc",
-        #     "ned",
-        #     "nyu_valueadded_gals",
-        #     "sdss_gals",
-        #     "veron_agn_qso",
-        #     "RC3",
-        # ]
-        # C3 = set(matching_catalog_names) & set(xsc_cats)
-        # if not C3:
-        # #     print ("No match with extragalactic catalog")
-        #     return
-        
+        matching_catalog_names = astro_objects.keys()
+        ps_cats = [
+            "bright_guide_star_cat", ##	Classification = 0 star
+            #"gaia_dr3_gaia_source", 
+            "sdss_stars", ## type = 6 star
+            "2mass_psc", 
+        ]
+        if "2mass_psc" in matching_catalog_names:
+            C3 = False
+        elif "bright_guide_star_cat" in matching_catalog_names and astro_objects['bright_guide_star_cat'][0]['classification']==0:
+            C3 = False
+        elif "sdss_stars" in matching_catalog_names and astro_objects['sdss_stars'][0]['type']==6:
+            C3 = False
+        # print ("C3", C3)
+        if not C3:
+            return   
 
         
-        TS_all = locus.timeseries('all')
         TS_lsst = locus.timeseries('lsst')
 
-        C4 = (len(TS_lsst) > 2) and (max(TS_lsst["ant_mjd"].data) - min(TS_lsst["ant_mjd"].data) < 30.0)
+        ## without upper limits info in alert packet, using a less strict time baseline
+        C4 = (len(TS_lsst) > 2) and (max(TS_lsst["ant_mjd"].data) - min(TS_lsst["ant_mjd"].data) < 15.0)
         if not C4:
             return
 

{antares_devkit-0.6.3 → antares_devkit-0.6.4}/antares_devkit/utils.py

@@ -23,7 +23,7 @@ def get_filters_path():
         "HighSNR": "antares_devkit.filters.highsnr",
         "IF_anomaly_detection": "antares_devkit.filters.if_anomaly_detection",  # ["numpy", "pandas", "sklearn", "astropy"]
         "IMBH": "antares_devkit.filters.imbh",
-        "In_LSSTDDF": "antares_devkit.filters.lsst_ddf", #["astropy", "numpy"]
+        "In_LSSTDDF": "antares_devkit.filters.lsst_ddf",  # ["astropy", "numpy"]
         "InM31": "antares_devkit.filters.inm31",
         "LAISS_RFC_AD_filter": "antares_devkit.filters.laiss_rfc_ad_filter",  # ["astropy", "timeout_decorator", "alerce", "numpy", "pandas", "matplotlib", "astro_ghost", "sklearn", "scipy"]
         "AnomalyTransientDmDt": "antares_devkit.filters.malanchev_anomaly_transient_dmdt",  # ["numpy", "astropy", "light_curve"]
@@ -36,6 +36,7 @@ def get_filters_path():
         "RecentReddening": "antares_devkit.filters.recent_reddening",
         "refitt_newsources_snrcut": "antares_devkit.filters.refitt_newsources_snrcut",
         "SampleFilter": "antares_devkit.filters.sample_filter",
+        "InShadowVirgo": "antares_devkit.filters.shadow_virgo",  # ["astropy", "numpy"]
         "siena_mag_coord_cut": "antares_devkit.filters.siena_mag_coord_cut",
         "SSOConfirmed": "antares_devkit.filters.sso",
         "sub_lum": "antares_devkit.filters.sub_lum",
@@ -48,6 +49,7 @@ def get_filters_path():
         "YoungExtragalacticCandidate": "antares_devkit.filters.young_extragalactic_candidate",
         "rubin_NovTest_soraisam": "antares_devkit.filters.rubin_NovTest_soraisam",
         "young_rubin_transients_soraisam": "antares_devkit.filters.young_rubin_transients_soraisam",
+        "LsstTransientQualityFilterScimma": "antares_devkit.filters.lsst_transient_quality_scimma",
     }
 
 

{antares_devkit-0.6.3 → antares_devkit-0.6.4}/pyproject.toml

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