make search_offset optional

Author: zoghbi-a

astroquery/heasarc/core.py

@@ -298,7 +298,7 @@ def query_tap(self, query, *, maxrec=None):
                        True, True, True, False)
     )
     def query_region(self, position=None, catalog=None, radius=None, *,
-                     spatial='cone', width=None, polygon=None,
+                     spatial='cone', width=None, polygon=None, add_offset=False,
                      get_query_payload=False, columns=None, cache=False,
                      verbose=False, maxrec=None,
                      **kwargs):
@@ -335,6 +335,10 @@ def query_region(self, position=None, catalog=None, radius=None, *,
             outlining the polygon to search in. It can also be a list of
             `astropy.coordinates` object or strings that can be parsed by
             `astropy.coordinates.ICRS`.
+        add_offset: bool
+            If True and spatial=='cone', add a search_offset column that
+            indicates the separation (in arcmin) between the requested
+            coordinate and the entry coordinates in the catalog. Default is False.
         get_query_payload : bool, optional
             If `True` then returns the generated ADQL query as str.
             Defaults to `False`.
@@ -399,9 +403,10 @@ def query_region(self, position=None, catalog=None, radius=None, *,
                     radius = coordinates.Angle(radius)
                 where = (" WHERE CONTAINS(POINT('ICRS',ra,dec),CIRCLE("
                          f"'ICRS',{ra},{dec},{radius.to(u.deg).value}))=1")
-                # add search_offset_ for the case of cone
-                columns += (",DISTANCE(POINT('ICRS',ra,dec), "
-                            f"POINT('ICRS',{ra},{dec})) as search_offset_")
+                # add search_offset for the case of cone
+                if add_offset:
+                    columns += (",DISTANCE(POINT('ICRS',ra,dec), "
+                                f"POINT('ICRS',{ra},{dec})) as search_offset")
             elif spatial.lower() == 'box':
                 if isinstance(width, str):
                     width = coordinates.Angle(width)
@@ -423,8 +428,8 @@ def query_region(self, position=None, catalog=None, radius=None, *,
         self._catalog_name = catalog
 
         table = response.to_table()
-        if 'search_offset_' in table.colnames:
-            table['search_offset_'].unit = u.arcmin
+        if add_offset:
+            table['search_offset'].unit = u.arcmin
         if len(table) == 0:
             warnings.warn(
                 NoResultsWarning("No matching rows were found in the query.")

astroquery/heasarc/tests/test_heasarc.py

@@ -82,7 +82,8 @@ def mock_meta():
 
 @pytest.mark.parametrize("coordinates", OBJ_LIST)
 @pytest.mark.parametrize("radius", SIZE_LIST)
-def test_query_region_cone(coordinates, radius):
+@pytest.mark.parametrize("offset", [True, False])
+def test_query_region_cone(coordinates, radius, offset):
     # use columns='*' to avoid remote call to obtain the default columns
     query = Heasarc.query_region(
         coordinates,
@@ -91,12 +92,16 @@ def test_query_region_cone(coordinates, radius):
         radius=radius,
         columns="*",
         get_query_payload=True,
+        add_offset=True,
     )
 
     # We don't fully float compare in this string, there are slight
     # differences due to the name-coordinate resolution and conversions
-    assert ("SELECT *,DISTANCE(POINT('ICRS',ra,dec), "
-            "POINT('ICRS',182.63") in query
+    if offset:
+        distance_text = ",DISTANCE(POINT('ICRS',ra,dec), POINT('ICRS',182.63"
+    else:
+        distance_text = ""
+    assert (f"SELECT *{distance_text}") in query
     assert (
         "FROM suzamaster WHERE CONTAINS(POINT('ICRS',ra,dec),"
         "CIRCLE('ICRS',182.63" in query