Move logic into commons

Author: snbianco

CHANGES.rst

@@ -36,13 +36,13 @@ gaia
 - New method cross_match_basic that simplifies the positional x-match method [#3320]
 - new DR4 datalink retrieve type MEAN_SPECTRUM_RVS [#3342]
 
-linelists.cdms
-^^^^^^^^^^^^^^
+mast
+^^^^
 
 - Add a keyword to control writing of new species cache files.  This is needed to prevent tests from overwriting those files. [#3297]
 
-heasarc
-^^^^^^^
+simbad
+^^^^^^
 
 - Add support for astropy.table.Row in Heasarc.download_data and Heasarc.locate_data. [#3270]
 - Heasarc.locate_data returns empty rows with an error in the error_message column if there are
@@ -2263,4 +2263,4 @@ Infrastructure, Utility and Other Changes and Additions
 0.1 (2013-09-19)
 ================
 
-- Initial release.  Includes features!
+- Initial release.  Includes features!

astroquery/mast/collections.py

@@ -19,7 +19,7 @@
 
 from astropy.table import Table, Row
 
-from ..utils import async_to_sync
+from ..utils import commons, async_to_sync
 from ..utils.class_or_instance import class_or_instance
 from ..exceptions import InvalidQueryError, MaxResultsWarning, InputWarning
 
@@ -204,7 +204,7 @@ def query_region_async(self, coordinates, *, radius=0.2*u.deg, catalog="Hsc",
         """
 
         # Put coordinates and radius into consistent format
-        coordinates = utils.parse_coordinates(coordinates)
+        coordinates = commons.parse_coordinates(coordinates, 'icrs')
 
         # if radius is just a number we assume degrees
         radius = coord.Angle(radius, u.deg)

astroquery/mast/missions.py

@@ -19,7 +19,7 @@
 from requests import HTTPError, RequestException
 
 from astroquery import log
-from astroquery.utils import async_to_sync
+from astroquery.utils import commons, async_to_sync
 from astroquery.utils.class_or_instance import class_or_instance
 from astropy.utils.console import ProgressBarOrSpinner
 from astroquery.exceptions import InvalidQueryError, MaxResultsWarning, InputWarning, NoResultsWarning
@@ -219,7 +219,7 @@ def query_region_async(self, coordinates, *, radius=3*u.arcmin, limit=5000, offs
         self._validate_criteria(**criteria)
 
         # Put coordinates and radius into consistent format
-        coordinates = utils.parse_coordinates(coordinates)
+        coordinates = commons.parse_coordinates(coordinates, 'icrs')
 
         # If radius is just a number, assume arcminutes
         radius = coord.Angle(radius, u.arcmin)

astroquery/mast/observations.py

@@ -22,6 +22,7 @@
 from astropy.table import Table, Row, vstack
 from astroquery import log
 from astroquery.mast.cloud import CloudAccess
+from astroquery.utils import commons
 
 from ..utils import async_to_sync
 from ..utils.class_or_instance import class_or_instance
@@ -234,7 +235,7 @@ def query_region_async(self, coordinates, *, radius=0.2*u.deg, pagesize=None, pa
         """
 
         # Put coordinates and radius into consistent format
-        coordinates = utils.parse_coordinates(coordinates)
+        coordinates = commons.parse_coordinates(coordinates, 'icrs')
 
         # if radius is just a number we assume degrees
         radius = coord.Angle(radius, u.deg)
@@ -363,7 +364,7 @@ def query_region_count(self, coordinates, *, radius=0.2*u.deg, pagesize=None, pa
         """
 
         # build the coordinates string needed by ObservationsClass._caom_filtered_position
-        coordinates = utils.parse_coordinates(coordinates)
+        coordinates = commons.parse_coordinates(coordinates, 'icrs')
 
         # if radius is just a number we assume degrees
         radius = coord.Angle(radius, u.deg)

astroquery/mast/utils.py

@@ -235,7 +235,7 @@ def parse_input_location(*, coordinates=None, objectname=None, resolver=None):
 
     # Parse coordinates, if given
     if coordinates:
-        obj_coord = commons.parse_coordinates(coordinates)
+        obj_coord = commons.parse_coordinates(coordinates, 'icrs')
 
     return obj_coord
 

astroquery/utils/commons.py

@@ -40,7 +40,7 @@
 ASTROPY_LT_7_1_1 = not minversion('astropy', '7.1.1')
 
 
-def parse_coordinates(coordinates):
+def parse_coordinates(coordinates, return_frame=None):
     """
     Takes a string or astropy.coordinates object. Checks if the
     string is parsable as an `astropy.coordinates`
@@ -51,6 +51,10 @@ def parse_coordinates(coordinates):
     ----------
     coordinates : str or `astropy.coordinates` object
         Astronomical coordinate
+    return_frame : `astropy.coordinates` frame
+        The frame to return the coordinates in. If None and `coordinates` is
+        a string, the frame will be ICRS. If `coordinates` is an `astropy.coordinates` object, the
+        frame will be the same as the input object.
 
     Returns
     -------
@@ -93,6 +97,14 @@ def parse_coordinates(coordinates):
             c = SkyCoord(coordinates)
     else:
         raise TypeError("Argument cannot be parsed as a coordinate")
+
+    # Convert to requested frame, if given
+    if return_frame and c.frame.name != return_frame.lower():
+        try:
+            c = c.transform_to(return_frame)
+        except ValueError:
+            warnings.warn(f"Failed to transform coordinates to requested frame: {return_frame}.", InputWarning)
+
     return c
 
 

astroquery/utils/tests/test_utils.py

@@ -15,6 +15,7 @@
 import astropy.utils.data as aud
 from astropy.logger import log
 
+from ...exceptions import InputWarning
 from ...utils import chunk_read, chunk_report, class_or_instance, commons
 from ...utils.process_asyncs import async_to_sync_docstr, async_to_sync
 from ...utils.docstr_chompers import remove_sections, prepend_docstr_nosections
@@ -80,6 +81,30 @@ def test_parse_coordinates_4():
     assert c.to_string() == coordinates
 
 
+def test_parse_coordinates_return_frame():
+    # String input should return in icrs frame
+    coords = commons.parse_coordinates('266.40498829 -28.93617776')
+    assert coords.frame.name == 'icrs'
+
+    # SkyCoord input without return_frame should return in original frame
+    galactic = coord.SkyCoord('0 0', unit='deg', frame='galactic')
+    coords = commons.parse_coordinates(galactic)
+    assert coords.frame.name == 'galactic'
+
+    # Parse a SkyCoord in galactic frame into icrs frame
+    galactic = coord.SkyCoord('0 0', unit='deg', frame='galactic')
+    icrs = galactic.transform_to('icrs')  # Expected result
+    coords = commons.parse_coordinates(galactic, return_frame='icrs')
+    assert icrs.ra.deg == coords.ra.deg
+    assert icrs.dec.deg == coords.dec.deg
+    assert galactic.frame.name == 'galactic'
+    assert coords.frame.name == 'icrs'
+
+    # Warn if transformation fails
+    with pytest.warns(InputWarning, match='Failed to transform coordinates'):
+        coords = commons.parse_coordinates(galactic, return_frame='invalid')
+
+
 col_1 = [1, 2, 3]
 col_2 = [0, 1, 0, 1, 0, 1]
 col_3 = ['v', 'w', 'x', 'y', 'z']