GAIASWRQ-25 The methods cross_match and cross_match_basic accept radius as a Quantiy

Author: Jorge Fernandez Hernandez

astroquery/gaia/core.py

@@ -790,7 +790,7 @@ def __getQuantityInput(self, value, msg):
         if value is None:
             raise ValueError(f"Missing required argument: {msg}")
         if not (isinstance(value, str) or isinstance(value, units.Quantity)):
-            raise ValueError(f"{msg} must be either a string or astropy.coordinates")
+            raise ValueError(f"{msg} must be either a string or astropy.coordinates: {type(value)}")
 
         if isinstance(value, str):
             return Quantity(value)
@@ -883,8 +883,9 @@ def cross_match_basic(self, *, table_a_full_qualified_name, table_a_column_ra, t
             the ‘dec’ column in the table table_b_full_qualified_name
         results_name : str, optional, default None
             custom name defined by the user for the job that is going to be created
-        radius : float (arc. seconds), optional, default 1.0
-            radius  (valid range: 0.1-10.0)
+        radius : float (arc. seconds), str or astropy.coordinate, optional, default 1.0
+            radius  (valid range: 0.1-10.0). For an astropy.coordinate any angular unit is valid, but its value in arc
+            sec must be contained within the valid range.
         background : bool, optional, default 'False'
             when the job is executed in asynchronous mode, this flag specifies
             whether the execution will wait until results are available
@@ -896,8 +897,12 @@ def cross_match_basic(self, *, table_a_full_qualified_name, table_a_column_ra, t
         A Job object
         """
 
-        if radius < 0.1 or radius > 10.0:
-            raise ValueError(f"Invalid radius value. Found {radius}, valid range is: 0.1 to 10.0")
+        radius_quantity = self.__get_radius_as_quantity_arcsec(radius)
+
+        radius_arc_sec = radius_quantity.value
+
+        if radius_arc_sec < 0.1 or radius_arc_sec > 10.0:
+            raise ValueError(f"Invalid radius value. Found {radius_quantity}, valid range is: 0.1 to 10.0")
 
         schema_a = self.__get_schema_name(table_a_full_qualified_name)
         if not schema_a:
@@ -928,7 +933,7 @@ def cross_match_basic(self, *, table_a_full_qualified_name, table_a_column_ra, t
             f"b.{table_b_column_dec}) AS separation, b.* "
             f"FROM {table_a_full_qualified_name} AS a JOIN {table_b_full_qualified_name} AS b "
             f"ON DISTANCE(a.{table_a_column_ra}, a.{table_a_column_dec}, b.{table_b_column_ra}, b.{table_b_column_dec})"
-            f" < {radius} / 3600.")
+            f" < {radius_quantity.to(u.deg).value}")
 
         return self.launch_job_async(query=query,
                                      name=results_name,
@@ -940,6 +945,16 @@ def cross_match_basic(self, *, table_a_full_qualified_name, table_a_column_ra, t
                                      upload_resource=None,
                                      upload_table_name=None)
 
+    def __get_radius_as_quantity_arcsec(self, radius):
+        """
+        transform the input radius into an astropy.Quantity in arc seconds
+        """
+        if not isinstance(radius, units.Quantity):
+            radius_quantity = Quantity(value=radius, unit=u.arcsec)
+        else:
+            radius_quantity = radius.to(u.arcsec)
+        return radius_quantity
+
     def __update_ra_dec_columns(self, full_qualified_table_name, column_ra, column_dec, table_metadata, verbose):
         """
         Update table metadata for the ‘ra’ and the ‘dec’ columns in the input table
@@ -1007,8 +1022,9 @@ def cross_match(self, *, full_qualified_table_name_a,
             a full qualified table name (i.e. schema name and table name)
         results_table_name : str, mandatory
             a table name without schema. The schema is set to the user one
-        radius : float (arc. seconds), optional, default 1.0
-            radius  (valid range: 0.1-10.0)
+        radius : float (arc. seconds), str or astropy.coordinate, optional, default 1.0
+            radius  (valid range: 0.1-10.0). For an astropy.coordinate any angular unit is valid, but its value in arc
+            sec must be contained within the valid range.
         background : bool, optional, default 'False'
             when the job is executed in asynchronous mode, this flag specifies
             whether the execution will wait until results are available
@@ -1019,8 +1035,13 @@ def cross_match(self, *, full_qualified_table_name_a,
         -------
         A Job object
         """
-        if radius < 0.1 or radius > 10.0:
-            raise ValueError(f"Invalid radius value. Found {radius}, valid range is: 0.1 to 10.0")
+
+        radius_quantity = self.__get_radius_as_quantity_arcsec(radius)
+
+        radius_arc_sec = radius_quantity.value
+
+        if radius_arc_sec < 0.1 or radius_arc_sec > 10.0:
+            raise ValueError(f"Invalid radius value. Found {radius_quantity}, valid range is: 0.1 to 10.0")
 
         schema_a = self.__get_schema_name(full_qualified_table_name_a)
 
@@ -1033,7 +1054,7 @@ def cross_match(self, *, full_qualified_table_name_a,
         if taputils.get_schema_name(results_table_name) is not None:
             raise ValueError("Please, do not specify schema for 'results_table_name'")
 
-        query = f"SELECT crossmatch_positional('{schema_a}','{table_a}','{schema_b}','{table_b}',{radius}, " \
+        query = f"SELECT crossmatch_positional('{schema_a}','{table_a}','{schema_b}','{table_b}',{radius_arc_sec}, " \
                 f"'{results_table_name}') FROM dual;"
 
         name = str(results_table_name)

astroquery/gaia/tests/test_gaiatap.py

@@ -25,6 +25,7 @@
 import pytest
 from astropy.coordinates.sky_coordinate import SkyCoord
 from astropy.table import Column, Table
+from astropy.units import Quantity
 from astropy.utils.data import get_pkg_data_filename
 from astropy.utils.exceptions import AstropyDeprecationWarning
 from requests import HTTPError
@@ -1361,7 +1362,7 @@ def test_cross_match_invalid_mandatory_kwarg(cross_match_kwargs, kwarg, invalid_
 def test_cross_match_invalid_radius(cross_match_kwargs, radius):
     with pytest.raises(
             ValueError,
-            match=rf"^Invalid radius value. Found {radius}, valid range is: 0.1 to 10.0$",
+            match=rf"^Invalid radius value. Found {radius} arcsec, valid range is: 0.1 to 10.0$",
     ):
         GAIA_QUERIER.cross_match(**cross_match_kwargs, radius=radius)
 
@@ -1450,6 +1451,20 @@ def update_user_table(self, table_name, list_of_changes, verbose):
     assert job.get_phase() == "EXECUTING" if background else "COMPLETED"
     assert job.failed is False
 
+    radius_quantity = Quantity(value=1.0, unit=u.arcsec)
+    job = mock_querier_async.cross_match_basic(table_a_full_qualified_name="user_hola.tableA", table_a_column_ra="ra",
+                                               table_a_column_dec="dec", radius=radius_quantity, background=background)
+    assert job.async_ is True
+    assert job.get_phase() == "EXECUTING" if background else "COMPLETED"
+    assert job.failed is False
+
+    radius_quantity = Quantity(value=1.0/3600.0, unit=u.deg)
+    job = mock_querier_async.cross_match_basic(table_a_full_qualified_name="user_hola.tableA", table_a_column_ra="ra",
+                                               table_a_column_dec="dec", radius=radius_quantity, background=background)
+    assert job.async_ is True
+    assert job.get_phase() == "EXECUTING" if background else "COMPLETED"
+    assert job.failed is False
+
 
 @pytest.mark.parametrize("background", [False, True])
 def test_cross_match_basic_wrong_column(monkeypatch, background, mock_querier_async):
@@ -1517,18 +1532,31 @@ def update_user_table(self, table_name, list_of_changes, verbose):
         GAIA_QUERIER.cross_match_basic(table_a_full_qualified_name="schema.table_name", table_a_column_ra="ra",
                                        table_a_column_dec="dec", table_b_full_qualified_name=".table_name")
 
-    error_message = "Invalid radius value. Found 50.0, valid range is: 0.1 to 10.0"
+    error_message = "Invalid radius value. Found 50.0 arcsec, valid range is: 0.1 to 10.0"
     with pytest.raises(ValueError, match=error_message):
         GAIA_QUERIER.cross_match_basic(table_a_full_qualified_name="schema.table_name", table_a_column_ra="ra",
                                        table_a_column_dec="dec", table_b_full_qualified_name="schema.table_name",
                                        radius=50.0)
 
-    error_message = "Invalid radius value. Found 0.01, valid range is: 0.1 to 10.0"
+    error_message = "Invalid radius value. Found 0.01 arcsec, valid range is: 0.1 to 10.0"
     with pytest.raises(ValueError, match=error_message):
         GAIA_QUERIER.cross_match_basic(table_a_full_qualified_name="schema.table_name", table_a_column_ra="ra",
                                        table_a_column_dec="dec", table_b_full_qualified_name="schema.table_name",
                                        radius=0.01)
 
+    radius_quantity = Quantity(value=0.01, unit=u.arcsec)
+    with pytest.raises(ValueError, match=error_message):
+        GAIA_QUERIER.cross_match_basic(table_a_full_qualified_name="schema.table_name", table_a_column_ra="ra",
+                                       table_a_column_dec="dec", table_b_full_qualified_name="schema.table_name",
+                                       radius=radius_quantity)
+
+    radius_quantity = Quantity(value=1.0, unit=u.deg)
+    error_message = "Invalid radius value. Found 3600.0 arcsec, valid range is: 0.1 to 10.0"
+    with pytest.raises(ValueError, match=error_message):
+        GAIA_QUERIER.cross_match_basic(table_a_full_qualified_name="schema.table_name", table_a_column_ra="ra",
+                                       table_a_column_dec="dec", table_b_full_qualified_name="schema.table_name",
+                                       radius=radius_quantity)
+
 
 @patch.object(TapPlus, 'login')
 def test_login(mock_login):