get_images doc

Author: burnout87

astroquery/desi/__init__.py

@@ -4,7 +4,7 @@
 DESI LegacySurvery
 
 https://www.legacysurvey.org/
--------------------------
+-----------------------------
 
 :author: Gabriele Barni ([email protected])
 """

astroquery/desi/core.py

@@ -26,29 +26,30 @@ def query_region(self, coordinates, radius=None, *, data_release=9):
         Parameters
         ----------
         coordinates : `~astropy.coordinates.SkyCoord`
-            coordinates around which to query.
+            coordinates around which we define our region of interest.
         radius : `~astropy.units.Quantity`, optional
-            the radius of the region. If missing, set to default
-            value of 0.5 arcmin.
-        data_release: int
+            the radius of the region to search.
+            Default to a value of 0.5 arcmin.
+        data_release: int, optional
             the data release of the LegacySurvey to use.
+            Default to 9.
 
         Returns
         -------
         response : `~astropy.table.Table`
         """
 
         if radius is None:
-            radius = Quantity(0.5, unit='arcmin')
+            radius = Quantity(0.5, u.arcmin)
 
         tap_service = vo.dal.TAPService(conf.tap_service_url)
         coordinates_transformed = coordinates.transform_to(coord.ICRS)
 
         qstr = (f"SELECT all * FROM ls_dr{data_release}.tractor WHERE "
-               f"dec>{(coordinates_transformed.dec - radius).to(u.deg).value} and "
-               f"dec<{(coordinates_transformed.dec + radius).to(u.deg).value} and "
-               f"ra>{coordinates_transformed.ra.to(u.deg).value - radius.to(u.deg).value / np.cos(coordinates_transformed.dec.to(u.deg).value * np.pi / 180.)} and "
-               f"ra<{coordinates_transformed.ra.to(u.deg).value + radius.to(u.deg).value / np.cos(coordinates_transformed.dec.to(u.deg).value * np.pi / 180)}")
+               f"dec>{(coordinates_transformed.dec - radius).to_value(u.deg)} and "
+               f"dec<{(coordinates_transformed.dec + radius).to_value(u.deg)} and "
+               f"ra>{coordinates_transformed.ra.to_value(u.deg) - radius.to_value(u.deg) / np.cos(coordinates_transformed.dec.to_value(u.deg) * np.pi / 180.)} and "
+               f"ra<{coordinates_transformed.ra.to_value(u.deg) + radius.to_value(u.deg) / np.cos(coordinates_transformed.dec.to_value(u.deg) * np.pi / 180)}")
 
         tap_result = tap_service.run_sync(qstr)
         tap_result = tap_result.to_table()
@@ -58,23 +59,29 @@ def query_region(self, coordinates, radius=None, *, data_release=9):
 
         return filtered_table
 
-    def get_images(self, position, pixels, radius=None, *, data_release=9, show_progress=True, image_band='g'):
+    def get_images(self, position, pixels=None, radius=None, *, data_release=9, show_progress=True, image_band='g'):
         """
         Downloads the images for a certain region of interest.
 
         Parameters
-        -------
-        position: `~astropy.coordinates`.
+        ----------
+        position: `~astropy.coordinates.SkyCoord`
             coordinates around which we define our region of interest.
-        radius: `~astropy.units.Quantity`,  optional
+        pixels: 'int', optional
+            pixel dimensions of the image to be produced.
+            Default to 60.
+        radius: `~astropy.units.Quantity`, optional
             the radius of our region of interest.
+            Default to a value of 0.5 arcmin.
         data_release: int, optional
             the data release of the LegacySurvey to use.
+            Default to 9.
         show_progress: bool, optional
-            Whether to display a progress bar if the file is downloaded
-            from a remote server.  Default is True.
+            whether to display a progress bar if the file is downloaded from a remote server.
+            Default to True.
         image_band: str, optional
-            Default to 'g'
+            indicates the desired band.
+            Default to 'g'.
 
         Returns
         -------

docs/desi/desi.rst

@@ -90,3 +90,10 @@ All the information we need can be found within the object "im".
 
 The variable "im" is a list of `~astropy.io.fits.HDUList` objects, one entry for
 each corresponding object.
+
+
+Reference/API
+=============
+
+.. automodapi:: astroquery.desi
+  :no-inheritance-diagram: