Skip to content

Commit

Permalink
Merge pull request #1941 from tinumide/alfalfa-doc-cleanup
Browse files Browse the repository at this point in the history
Alfalfa documentation clean up
  • Loading branch information
bsipocz authored May 23, 2022
2 parents 68b408a + 8f330cf commit 4d54b64
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
8 changes: 4 additions & 4 deletions astroquery/alfalfa/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,21 +45,21 @@ def get_catalog(self):
return self.ALFALFACAT

result = requests.get(self.CATALOG_PREFIX)
iterable_lines = result.iter_lines()
iterable_lines = result.text.split('\n')

# Read header
cols = [col for col in next(iterable_lines).rstrip('\n').split(',')]
cols = iterable_lines[0].split(',')

catalog = {}
for col in cols:
catalog[col] = []

# Parse result
for line in iterable_lines:
for line in iterable_lines[1:]:
# skip blank lines or trailing newlines
if line == "":
continue
col_values = line.rstrip('\n').split(',')
col_values = line.split(',')
for i, col in enumerate(cols):
item = col_values[i].strip()
if item == '\"\"':
Expand Down
18 changes: 12 additions & 6 deletions docs/alfalfa/alfalfa.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. doctest-skip-all
.. _astroquery.alfalfa:

ALFALFA Queries (`astroquery.alfalfa`)
Expand All @@ -12,12 +10,14 @@ This example shows how to perform an object cross-ID with ALFALFA. We'll start
with the position of a source that exists in another survey (same object we
used in the SDSS example).

.. code-block:: python
.. doctest-remote-data::

>>> from astroquery.alfalfa import Alfalfa
>>> from astropy import coordinates as coords
>>> pos = coords.SkyCoord('0h8m05.63s +14d50m23.3s')
>>> agc = Alfalfa.query_region(pos, optical_counterpart=True)
>>> agc
100051

This retrieves the AGC number of the object closest to the supplied ra and dec
(within search radius dr=3 arcminutes by default). The "optical_counterpart" keyword
Expand All @@ -27,19 +27,25 @@ determined by members of the ALFALFA team), rather than their radio centroids.
The AGC number is an identification number for objects in the ALFALFA survey,
and once we know it, we can download spectra (if they are available) easily,

.. code-block:: python
.. Remove the skip once #2403 is fixed
.. .. doctest-remote-data::
.. doctest-skip::

>>> sp = Alfalfa.get_spectrum(agc)

This returns a PyFITS HDUList object. If we want to have a look at the entire ALFALFA catalog, we can do that too:
This returns a `~astropy.io.fits.HDUList` object. If we want to have a look at the
entire ALFALFA catalog as a dictionary, we can do that too:

.. code-block:: python
.. doctest-remote-data::

>>> cat = Alfalfa.get_catalog()
>>> cat.keys()
dict_keys(['AGCNr', 'Name', 'RAdeg_HI', 'Decdeg_HI', 'RAdeg_OC', 'DECdeg_OC', 'Vhelio', 'W50', 'errW50', 'HIflux', 'errflux', 'SNR', 'RMS', 'Dist', 'logMsun', 'HIcode', 'OCcode', 'NoteFlag'])

which returns a dictionary containing HI measurements for nearly 16,000
objects.


Reference/API
-------------

Expand Down

0 comments on commit 4d54b64

Please sign in to comment.