Add ZTF crossmatch

winter-telescope · Aug 20, 2024 · e168e7a · e168e7a
1 parent 5b6318d
commit e168e7a
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 3 deletions.
diff --git a/mirar/catalog/kowalski/__init__.py b/mirar/catalog/kowalski/__init__.py
@@ -6,3 +6,4 @@
 from mirar.catalog.kowalski.gaia import Gaia, GaiaBright
 from mirar.catalog.kowalski.ps1 import PS1, PS1STRM, PS1SGSc
 from mirar.catalog.kowalski.tmass import TMASS
+from mirar.catalog.kowalski.ztf import ZTF
diff --git a/mirar/catalog/kowalski/ztf.py b/mirar/catalog/kowalski/ztf.py
@@ -0,0 +1,34 @@
+"""
+Module for querying ZTF using Kowalski
+"""
+
+from mirar.catalog.kowalski.base_kowalski_catalog import BaseKowalskiXMatch
+
+
+class ZTF(BaseKowalskiXMatch):
+    """
+    ZTF Kowalski catalog
+    """
+
+    catalog_name = "ZTF_alerts"
+    abbreviation = "ztf"
+    projection = {
+        "objectId": 1,
+        "ra": 1,
+        "dec": 1,
+    }
+
+    column_names = {
+        "objectId": "ztfname",
+        "ra": f"{abbreviation}ra",
+        "dec": f"{abbreviation}dec",
+    }
+
+    column_dtypes = {
+        "ztfname": str,
+        "ztfra": float,
+        "ztfdec": float,
+    }
+
+    ra_column_name = f"{abbreviation}ra"
+    dec_column_name = f"{abbreviation}dec"
diff --git a/mirar/pipelines/winter/blocks.py b/mirar/pipelines/winter/blocks.py
@@ -7,7 +7,7 @@
 
 from winterrb.model import WINTERNet
 
-from mirar.catalog.kowalski import PS1, PS1STRM, TMASS, Gaia, GaiaBright, PS1SGSc
+from mirar.catalog.kowalski import PS1, PS1STRM, TMASS, ZTF, Gaia, GaiaBright, PS1SGSc
 from mirar.downloader.get_test_data import get_test_data_dir
 from mirar.paths import (
     BASE_NAME_KEY,
@@ -715,6 +715,7 @@
     XMatch(catalog=PS1STRM(num_sources=3, search_radius_arcmin=0.5)),
     XMatch(catalog=Gaia(num_sources=1, search_radius_arcmin=1.5)),
     XMatch(catalog=GaiaBright(num_sources=1, search_radius_arcmin=1.5)),
+    XMatch(catalog=ZTF(num_sources=1, search_radius_arcmin=2.0 / 60.0)),
     CustomSourceTableModifier(
         modifier_function=winter_candidate_avro_fields_calculator
     ),

diff --git a/mirar/pipelines/winter/config/files/avro_schema/winter.alert.avsc b/mirar/pipelines/winter/config/files/avro_schema/winter.alert.avsc
@@ -4,7 +4,7 @@
     "name": "alert",
     "doc": "avro alert schema for WINTER",
     "fields": [
-        {"name": "schemavsn", "type": "string", "doc": "schema version used", "default": "0.3"},
+        {"name": "schemavsn", "type": "string", "doc": "schema version used", "default": "0.4"},
         {"name": "publisher", "type": "string", "doc": "origin of alert packet", "default": "WINTER-mirar"},
         {"name": "objectid", "type": "string", "doc": "name of parent source, e.g 'WNTR24aaaab'"},
         {"name": "candid", "type": "long"},

diff --git a/mirar/pipelines/winter/config/files/avro_schema/winter.alert.candidate.avsc b/mirar/pipelines/winter/config/files/avro_schema/winter.alert.candidate.avsc
@@ -127,6 +127,8 @@
 		{"name": "ruwegaia", "type": ["float", "null"], "doc": "Random Unit Weighted Error of closest source from Gaia EDR3 catalog; if exists within 90 arcsec [mas]"},
 		{"name": "distgaiabright", "type": ["float", "null"], "doc": "Distance to closest source from Gaia DR3 catalog brighter than magnitude 14; if exists within 90 arcsec [arcsec]"},
 		{"name": "plxgaiabright", "type": ["float", "null"], "doc": "Absolute (parallax/sigma) of closest source from Gaia EDR3 catalog brighter than magnitude 14; if exists within 90 arcsec [mag]"},
-		{"name": "ruwegaiabright", "type": ["float", "null"], "doc": "Random Unit Weighted Error of closest source from Gaia EDR3 catalog brighter than magnitude 14; if exists within 90 arcsec [mas]"}
+		{"name": "ruwegaiabright", "type": ["float", "null"], "doc": "Random Unit Weighted Error of closest source from Gaia EDR3 catalog brighter than magnitude 14; if exists within 90 arcsec [mas]"},
+		{"name": "ztfname", "type": ["string", "null"], "doc": "ZTF name of candidate if exists within 2 arcsec, e.g. ZTF20abzqkxg"},
+		{"name": "distztf", "type": ["float", "null"], "doc": "Distance to closest source from ZTF alert catalog; if exists within 2 arcsec [arcsec]"}
 	]
 }
diff --git a/mirar/pipelines/winter/generator/candidates.py b/mirar/pipelines/winter/generator/candidates.py
@@ -228,6 +228,9 @@ def winter_candidate_avro_fields_calculator(source_table: SourceBatch) -> Source
         src_df["plxgaiabright"] = src_df["gaiabright_parallax_over_error1"]
         src_df["ruwegaiabright"] = src_df["gaiabright_ruwe1"]
 
+        src_df["distztf"] = src_df["distztf1"]
+        src_df["ztfname"] = src_df["ztfname1"]
+
         source.set_data(src_df)
         new_batch.append(source)
 

diff --git a/mirar/pipelines/winter/models/_candidates.py b/mirar/pipelines/winter/models/_candidates.py
@@ -209,6 +209,10 @@ class CandidatesTable(WinterBase):  # pylint: disable=too-few-public-methods
     plxgaiabright = Column(Float, nullable=True)
     ruwegaiabright = Column(Float, nullable=True)
 
+    # ZTF properties
+    ztfname = Column(VARCHAR(12), nullable=True)
+    distztf = Column(Float, nullable=True)
+
 
 class Candidate(BaseDB):
     """
@@ -343,6 +347,9 @@ class Candidate(BaseDB):
     plxgaiabright: float | None = Field(default=None)
     ruwegaiabright: float | None = Field(ge=0, default=None)
 
+    ztfname: str | None = Field(default=None, max_length=12)
+    distztf: float | None = Field(ge=0, default=None)
+
     def insert_entry(
         self, duplicate_protocol, returning_key_names=None
     ) -> pd.DataFrame: