Skip to content

Commit 0c35eb0

Browse files
bsipoczbsipocz
committed
DOC: Updating narrative docs
1 parent 5e8c097 commit 0c35eb0

File tree

1 file changed

+70
-76
lines changed

1 file changed

+70
-76
lines changed

‎docs/ipac/irsa/irsa.rst

Lines changed: 70 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,20 @@ a look at all the available catalogs:
3737
...
3838
'xmm_cat_s05': "SWIRE XMM_LSS Region Spring '05 Spitzer Catalog"}
3939

40-
This returns a dictionary of catalog names with their description. If you would
41-
rather just print out this information:
40+
To access the full VOTable of the catalog information, use the ``full`` keyword argument.
4241

4342
.. doctest-remote-data::
4443

4544
>>> from astroquery.ipac.irsa import Irsa
46-
>>> Irsa.print_catalogs()
47-
allwise_p3as_psd AllWISE Source Catalog
48-
allwise_p3as_mep AllWISE Multiepoch Photometry Table
49-
allwise_p3as_psr AllWISE Reject Table
45+
>>> Irsa.list_catalogs(full=True) # doctest: +IGNORE_OUTPUT
46+
<DALResultsTable length=934>
47+
table_index schema_name table_name description ... irsa_access_flag irsa_nrows irsa_odbc_datasource irsa_spatial_idx_name
48+
int32 object object object ... int32 int64 object object
49+
----------- ----------- ---------------------------------- --------------------------------------------- ... ---------------- ---------- -------------------- ---------------------
50+
303 spitzer spitzer.m31irac_image M31IRAC Images ... 30 4 postgres
51+
304 spitzer mipslg MIPS Local Galaxies Catalog ... 30 240 spitzer SPT_IND_MIPSLG
52+
305 spitzer spitzer.mips_lg_images MIPS Local Galaxies Images ... 30 606 postgres
5053
...
51-
wisegalhii WISE Catalog of Galactic HII Regions v2.2
52-
denis3 DENIS 3rd Release (Sep. 2005)
5354

5455

5556
Performing a cone search
@@ -68,43 +69,42 @@ entered as a string that is parsable by `~astropy.coordinates.Angle`.
6869
>>> import astropy.units as u
6970
>>> table = Irsa.query_region("m31", catalog="fp_psc", spatial="Cone",
7071
... radius=2 * u.arcmin)
71-
>>> print(table) # doctest: +IGNORE_OUTPUT
72-
ra dec clon clat ... angle j_h h_k j_k
73-
deg deg ... deg
74-
---------- ---------- ------------ ------------ ... ---------- ----- ----- -----
75-
10.684737 41.269035 00h42m44.34s 41d16m08.53s ... 4.072939 0.785 0.193 0.978
76-
10.683469 41.268585 00h42m44.03s 41d16m06.91s ... 259.968952 -- -- --
77-
... ... ... ... ... ... ... ... ...
78-
10.725972 41.280636 00h42m54.23s 41d16m50.29s ... 69.015201 -- -- --
79-
10.656898 41.294655 00h42m37.66s 41d17m40.76s ... 321.112765 1.237 -- --
80-
10.647116 41.286366 00h42m35.31s 41d17m10.92s ... 301.956547 -- -- --
81-
Length = 500 rows
82-
72+
>>> print(table)
73+
ra dec err_maj err_min ... coadd_key coadd htm20
74+
deg deg arcsec arcsec ...
75+
---------- ---------- ------- ------- ... --------- ----- -------------------
76+
10.692216 41.260162 0.10 0.09 ... 1590591 33 4805203678124326400
77+
10.700059 41.263481 0.31 0.30 ... 1590591 33 4805203678125364736
78+
10.699131 41.263248 0.28 0.20 ... 1590591 33 4805203678125474304
79+
... ... ... ... ... ... ... ...
80+
10.661414 41.242363 0.21 0.20 ... 1590591 33 4805203679644192256
81+
10.665184 41.240238 0.14 0.13 ... 1590591 33 4805203679647824896
82+
10.663245 41.240646 0.24 0.21 ... 1590591 33 4805203679649555456
83+
Length = 774 rows
8384

8485
The coordinates of the center may be specified rather than using the target
85-
name. The coordinates can be specified using the appropriate
86-
`astropy.coordinates` object. ICRS coordinates may also be entered directly as
87-
a string, as specified by `astropy.coordinates`:
86+
name. The coordinates can be specified using a `~astropy.coordinates.SkyCoord`
87+
object or a string resolvable by the `~astropy.coordinates.SkyCoord` constructor.
8888

8989
.. doctest-remote-data::
9090

9191
>>> from astroquery.ipac.irsa import Irsa
92-
>>> import astropy.coordinates as coord
93-
>>> table = Irsa.query_region(coord.SkyCoord(121.1743,
94-
... -21.5733, unit=(u.deg,u.deg),
95-
... frame='galactic'),
92+
>>> from astropy.coordinates import SkyCoord
93+
>>> coord = SkyCoord(121.1743, -21.5733, unit='deg', frame='galactic')
94+
>>> table = Irsa.query_region(coordinates=coord,
9695
... catalog='fp_psc', radius='0d2m0s')
9796
>>> print(table)
98-
ra dec clon clat ... angle j_h h_k j_k
99-
deg deg ... deg
100-
---------- ---------- ------------ ------------ ... ---------- ----- ----- -----
101-
10.684737 41.269035 00h42m44.34s 41d16m08.53s ... 10.37715 0.785 0.193 0.978
102-
10.683469 41.268585 00h42m44.03s 41d16m06.91s ... 259.028985 -- -- --
103-
10.685657 41.269550 00h42m44.56s 41d16m10.38s ... 43.199247 -- -- --
104-
... ... ... ... ... ... ... ... ...
105-
10.656898 41.294655 00h42m37.66s 41d17m40.76s ... 321.14224 1.237 -- --
106-
10.647116 41.286366 00h42m35.31s 41d17m10.92s ... 301.969315 -- -- --
107-
Length = 500 rows
97+
ra dec err_maj err_min ... coadd_key coadd htm20
98+
deg deg arcsec arcsec ...
99+
---------- ---------- ------- ------- ... --------- ----- -------------------
100+
10.692216 41.260162 0.10 0.09 ... 1590591 33 4805203678124326400
101+
10.700059 41.263481 0.31 0.30 ... 1590591 33 4805203678125364736
102+
10.699131 41.263248 0.28 0.20 ... 1590591 33 4805203678125474304
103+
... ... ... ... ... ... ... ...
104+
10.661414 41.242363 0.21 0.20 ... 1590591 33 4805203679644192256
105+
10.665184 41.240238 0.14 0.13 ... 1590591 33 4805203679647824896
106+
10.663245 41.240646 0.24 0.21 ... 1590591 33 4805203679649555456
107+
Length = 774 rows
108108

109109

110110
Performing a box search
@@ -129,20 +129,15 @@ for cone search queries, above - so it may be set using the appropriate
129129
---------- ---------- ------------ ------------ ... ------- ----- ----- -----
130130
10.684737 41.269035 00h42m44.34s 41d16m08.53s ... -- 0.785 0.193 0.978
131131

132-
Note that in this case we directly passed ICRS coordinates as a string to the
133-
:meth:`~astroquery.ipac.irsa.IrsaClass.query_region`.
134-
135-
136132
Queries over a polygon
137133
----------------------
138134

139135
Polygon queries can be performed by setting ``spatial='Polygon'``. The search
140136
center is optional in this case. One additional parameter that must be set for
141137
these queries is ``polygon``. This is a list of coordinate pairs that define a
142138
convex polygon. The coordinates may be specified as usual by using the
143-
appropriate `astropy.coordinates` object (Again ICRS coordinates may be
144-
directly passed as properly formatted strings). In addition to using a list of
145-
`astropy.coordinates` objects, one additional convenient means of specifying
139+
appropriate `~astropy.coordinates.SkyCoord` object. In addition to using a list of
140+
`~astropy.coordinates.SkyCoord` objects, one additional convenient means of specifying
146141
the coordinates is also available - Coordinates may also be entered as a list of
147142
tuples, each tuple containing the ra and dec values in degrees. Each of these
148143
options is illustrated below:
@@ -157,16 +152,16 @@ options is illustrated below:
157152
... coordinates.SkyCoord(ra=10.0, dec=10.0, unit=(u.deg, u.deg), frame='icrs')
158153
... ])
159154
>>> print(table)
160-
ra dec clon clat ... ext_key j_h h_k j_k
161-
deg deg ...
162-
---------- ---------- ------------ ------------ ... ------- ----- ----- -----
163-
10.015839 10.038061 00h40m03.80s 10d02m17.02s ... -- 0.552 0.313 0.865
164-
10.015696 10.099228 00h40m03.77s 10d05m57.22s ... -- 0.602 0.154 0.756
165-
10.011170 10.093903 00h40m02.68s 10d05m38.05s ... -- 0.378 0.602 0.98
166-
10.031016 10.063082 00h40m07.44s 10d03m47.10s ... -- 0.809 0.291 1.1
167-
10.036776 10.060278 00h40m08.83s 10d03m37.00s ... -- 0.468 0.372 0.84
168-
10.059964 10.085445 00h40m14.39s 10d05m07.60s ... -- 0.697 0.273 0.97
169-
10.005549 10.018401 00h40m01.33s 10d01m06.24s ... -- 0.662 0.566 1.228
155+
ra dec err_maj err_min ... coadd_key coadd htm20
156+
deg deg arcsec arcsec ...
157+
---------- ---------- ------- ------- ... --------- ----- -------------------
158+
10.015839 10.038061 0.09 0.06 ... 1443005 91 4805087709670704640
159+
10.015696 10.099228 0.10 0.07 ... 1443005 91 4805087709940635648
160+
10.011170 10.093903 0.23 0.21 ... 1443005 91 4805087710032524288
161+
10.031016 10.063082 0.19 0.18 ... 1443005 91 4805087710169327616
162+
10.036776 10.060278 0.11 0.06 ... 1443005 91 4805087710175392768
163+
10.059964 10.085445 0.23 0.20 ... 1443005 91 4805087710674674176
164+
10.005549 10.018401 0.16 0.14 ... 1443005 91 4805087784811171840
170165

171166
Another way to specify the polygon is directly as a list of tuples - each tuple
172167
is an ra, dec pair expressed in degrees:
@@ -177,25 +172,24 @@ is an ra, dec pair expressed in degrees:
177172
>>> table = Irsa.query_region("m31", catalog="fp_psc", spatial="Polygon",
178173
... polygon = [(10.1, 10.1), (10.0, 10.1), (10.0, 10.0)]) # doctest: +IGNORE_WARNINGS
179174
>>> print(table)
180-
ra dec clon clat ... ext_key j_h h_k j_k
181-
deg deg ...
182-
---------- ---------- ------------ ------------ ... ------- ----- ----- -----
183-
10.015839 10.038061 00h40m03.80s 10d02m17.02s ... -- 0.552 0.313 0.865
184-
10.015696 10.099228 00h40m03.77s 10d05m57.22s ... -- 0.602 0.154 0.756
185-
10.011170 10.093903 00h40m02.68s 10d05m38.05s ... -- 0.378 0.602 0.98
186-
10.031016 10.063082 00h40m07.44s 10d03m47.10s ... -- 0.809 0.291 1.1
187-
10.036776 10.060278 00h40m08.83s 10d03m37.00s ... -- 0.468 0.372 0.84
188-
10.059964 10.085445 00h40m14.39s 10d05m07.60s ... -- 0.697 0.273 0.97
189-
10.005549 10.018401 00h40m01.33s 10d01m06.24s ... -- 0.662 0.566 1.228
190-
175+
ra dec err_maj err_min ... coadd_key coadd htm20
176+
deg deg arcsec arcsec ...
177+
---------- ---------- ------- ------- ... --------- ----- -------------------
178+
10.015839 10.038061 0.09 0.06 ... 1443005 91 4805087709670704640
179+
10.015696 10.099228 0.10 0.07 ... 1443005 91 4805087709940635648
180+
10.011170 10.093903 0.23 0.21 ... 1443005 91 4805087710032524288
181+
10.031016 10.063082 0.19 0.18 ... 1443005 91 4805087710169327616
182+
10.036776 10.060278 0.11 0.06 ... 1443005 91 4805087710175392768
183+
10.059964 10.085445 0.23 0.20 ... 1443005 91 4805087710674674176
184+
10.005549 10.018401 0.16 0.14 ... 1443005 91 4805087784811171840
191185

192186
Selecting Columns
193187
--------------------
194188

195189
The IRSA service allows to query either a subset of the default columns for
196190
a given table, or additional columns that are not present by default. This
197191
can be done by listing all the required columns separated by a comma (,) in
198-
a string with the ``selcols`` argument.
192+
a string with the ``columns`` argument.
199193

200194

201195
An example where the AllWISE Source Catalog needs to be queried around the
@@ -205,12 +199,12 @@ star HIP 12 with just the ra, dec and w1mpro columns would be:
205199
.. doctest-remote-data::
206200

207201
>>> from astroquery.ipac.irsa import Irsa
208-
>>> table = Irsa.query_region("HIP 12", catalog="allwise_p3as_psd", spatial="Cone", selcols="ra,dec,w1mpro")
202+
>>> table = Irsa.query_region("HIP 12", catalog="allwise_p3as_psd", spatial="Cone", columns="ra,dec,w1mpro")
209203
>>> print(table)
210-
ra dec clon clat w1mpro dist angle
211-
deg deg mag arcsec deg
212-
----------- ----------- ------------ ------------- ------- -------- ----------
213-
0.0407905 -35.9602605 00h00m09.79s -35d57m36.94s 4.837 0.350806 245.442148
204+
ra dec w1mpro
205+
deg deg mag
206+
----------- ----------- -------
207+
0.0407905 -35.9602605 4.837
214208

215209
A list of available columns for each catalog can be found at
216210
https://irsa.ipac.caltech.edu/holdings/catalogs.html. The "Long Form" button
@@ -230,14 +224,14 @@ individual columns may be set to increase the precision.
230224
.. doctest-remote-data::
231225

232226
>>> from astroquery.ipac.irsa import Irsa
233-
>>> table = Irsa.query_region("HIP 12", catalog="allwise_p3as_psd", spatial="Cone", selcols="ra,dec,w1mpro")
227+
>>> table = Irsa.query_region("HIP 12", catalog="allwise_p3as_psd", spatial="Cone", columns="ra,dec,w1mpro")
234228
>>> table['ra'].format = '{:10.6f}'
235229
>>> table['dec'].format = '{:10.6f}'
236230
>>> print(table)
237-
ra dec clon clat w1mpro dist angle
238-
deg deg mag arcsec deg
239-
---------- ---------- ------------ ------------- ------- -------- ----------
240-
0.040791 -35.960260 00h00m09.79s -35d57m36.94s 4.837 0.350806 245.442148
231+
ra dec w1mpro
232+
deg deg mag
233+
---------- ---------- -------
234+
0.040791 -35.960260 4.837
241235

242236

243237
Other Configurations

0 commit comments

Comments
 (0)