Force i:ssnamenr to be in the payload (#58)

* Check mandatory fields for cutouts

* Force ssnamenr to be in the payload by default

* Left TODOs

* Add missing fields in the schema (#61)

* Expand test

Author: JulienPeloton

apps/routes/v1/schema/api.py

@@ -293,6 +293,16 @@ def get(self):
                     "type": "float",
                     "doc": "Feature for characterising CTAO blazar state. Related to low state duration.",
                 },
+                {
+                    "name": "gaiaClass",
+                    "type": "str",
+                    "doc": "Name of best class from Gaia DR3 Part 4. Variability (I/358/vclassre).",
+                },
+                {
+                    "name": "gaiaVarFlag",
+                    "type": "int",
+                    "doc": "Photometric variability flag from Gaia DR3. 1 if the source is variable, 0 otherwise.",
+                },
             ],
         )
 

apps/routes/v1/schema/test.py

@@ -146,6 +146,8 @@ def check_old_columns(columns, objectId):
                 "blazar_stats_m0",
                 "blazar_stats_m1",
                 "blazar_stats_m2",
+                "gaiaVarFlag",
+                "gaiaClass",
             ]
 
             outside_obtained = [i for i in definition if i not in obtained]

apps/routes/v1/sso/test.py

@@ -1,4 +1,4 @@
-# Copyright 2022 AstroLab Software
+# Copyright 2022-2025 AstroLab Software
 # Author: Julien Peloton
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

apps/routes/v1/sso/utils.py

@@ -72,6 +72,20 @@ def extract_sso_data(payload: dict) -> pd.DataFrame:
     ):
         with_cutouts = True
 
+    if with_cutouts and truncated:
+        # Check mandatory fields
+        if "i:objectId" not in cols or "i:candid" not in cols:
+            rep = {
+                "status": "error",
+                "text": "You need to add 'i:objectId,i:candid' to the columns.\n",
+            }
+            return Response(str(rep), 400)
+
+    if truncated and "i:ssnamenr" not in cols:
+        # For name resolving, i:ssnamenr must be here
+        # In case the user forgot, let's add it silently
+        cols += ",i:ssnamenr"
+
     n_or_d = str(payload["n_or_d"])
 
     if "," in n_or_d:
@@ -187,14 +201,12 @@ def extract_sso_data(payload: dict) -> pd.DataFrame:
                 download_cutout(row["i:objectId"], row["i:candid"], cutout_kind)
             )
         pdf[colname] = cutouts
-        # pdf[colname] = pdf[["i:objectId", "i:candid"]].apply(
-        #    lambda x: pd.Series([download_cutout(x.iloc[0], x.iloc[1], cutout_kind)]),
-        #    axis=1,
-        # )
 
     if with_ephem:
-        # We should probably add a timeout
-        # and try/except in case of miriade shutdown
+        # TODO: In case truncated is True, check (before DB call)
+        #       the mandatory fields have been requested
+        # TODO: We should probably add a timeout and try/except
+        #       in case of miriade shutdown
         pdf = get_miriade_data(pdf, sso_colname="sso_name")
         if "i:magpsf_red" not in pdf.columns:
             rep = {
@@ -204,13 +216,11 @@ def extract_sso_data(payload: dict) -> pd.DataFrame:
             return Response(str(rep), 400)
 
     if with_residuals:
-        # get phase curve parameters using
-        # the sHG1G2 model
+        # TODO: In case truncated is True, check (before DB call)
+        #       the mandatory fields have been requested
 
-        # Phase angle, in radians
+        # Get phase curve parameters using the sHG1G2 model
         phase = np.deg2rad(pdf["Phase"].values)
-
-        # Required for sHG1G2
         ra = np.deg2rad(pdf["i:ra"].values)
         dec = np.deg2rad(pdf["i:dec"].values)