Merge pull request #47 from alercebroker/feat/fp_query

Added border case and doc
alercebroker · Jan 6, 2025 · e90246f · e90246f
2 parents e7002cc + b9da71d
commit e90246f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 8 deletions.
diff --git a/alerce/search.py b/alerce/search.py
@@ -195,16 +195,20 @@ def query_forced_photometry(self, oid, format="json", index=None, sort=None):
                 new_result.update(extra_fields)
                 parsed_result.append(new_result)
         if format == "pandas" or format == "csv":
-            extra_fields = complete_result["extra_fields"].copy()
-            complete_result = complete_result.drop(columns=FIELDS_TO_REMOVE)
-            # expand
             import pandas as pd
 
-            extra_fields = pd.json_normalize(extra_fields)
-            # merge
-            parsed_result = complete_result.merge(extra_fields)
-            if format == "csv":
-                parsed_result = parsed_result.to_csv(index=False)
+            if len(complete_result) == 0:
+                # the object dont have any fp
+                return pd.DataFrame()
+            else: 
+                extra_fields = complete_result["extra_fields"].copy()
+                complete_result = complete_result.drop(columns=FIELDS_TO_REMOVE)
+                # expand
+                extra_fields = pd.json_normalize(extra_fields)
+                # merge
+                parsed_result = complete_result.merge(extra_fields)
+                if format == "csv":
+                    parsed_result = parsed_result.to_csv(index=False)
 
         return parsed_result
 

diff --git a/docs/source/tutorials/ztf_api.rst b/docs/source/tutorials/ztf_api.rst
@@ -94,6 +94,7 @@ Query Lightcurve
 
 To get the lightcurve for an object the method :func:`~alerce.core.Alerce.query_lightcurve` can be used, this will return
 a dictionary with Detections and Non-detections for that object, also we can get them separetly with :func:`~alerce.core.Alerce.query_detections` and :func:`~alerce.core.Alerce.query_non_detections`.
+Also, there is a method to access the forced photometries of an object :func:`~alerce.core.Alerce.query_forced_photometry`.
 
 .. code-block:: python
 
@@ -105,6 +106,9 @@ a dictionary with Detections and Non-detections for that object, also we can get
     non_detections = alerce.query_non_detections("ZTF18abbuksn",
                                                  format="json")
 
+    # Getting forced photometry for an object
+    non_detections = alerce.query_forced_photometry("ZTF18abbuksn",
+                                                 format="json")
     # Getting lightcurve for an object
     lightcurve = alerce.query_lightcurve("ZTF18abbuksn",
                                          format="json")