Skip to content

Commit ffa7e4e

Browse files
bsipoczbsipocz
committed
More fixes to irsa and irsa_dust docs
1 parent bffa2bd commit ffa7e4e

File tree

2 files changed

+117
-111
lines changed

2 files changed

+117
-111
lines changed

‎docs/irsa/irsa.rst

Lines changed: 79 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ IRSA Queries (`astroquery.irsa`)
77
Getting started
88
===============
99

10-
1110
This module can has methods to perform different types of queries on the
1211
catalogs present in the IRSA general catalog service. All queries can be
1312
performed by calling :meth:`~astroquery.irsa.IrsaClass.query_region`, with
@@ -16,6 +15,7 @@ supported: ``Cone``, ``Box``, ``Polygon`` and ``All-Sky``. All successful
1615
queries return the results in a `~astropy.table.Table`. We now look at some
1716
examples.
1817

18+
1919
Available catalogs
2020
------------------
2121

@@ -45,16 +45,14 @@ rather just print out this information:
4545
.. doctest-remote-data::
4646

4747
>>> from astroquery.irsa import Irsa
48-
>>> Irsa.print_catalogs() # doctest: +IGNORE_OUTPUT
49-
wise_allsky_2band_p1bm_frm WISE Post-Cryo Single Exposure (L1b) Image Inventory Table
50-
wise_allsky_4band_p3as_psr WISE All-Sky Reject Table
51-
cosmos_morph_col_1 COSMOS Zamojski Morphology Catalog v1.0
52-
wise_prelim_p3al_lod WISE Preliminary Release Atlas Inventory Table (Superseded)
53-
com_pccs1_100 Planck PCCS 100GHz Catalog
54-
swire_lhisod SWIRE Lockman Hole ISOCAM Deep Field Catalog
48+
>>> Irsa.print_catalogs()
49+
allwise_p3as_psd AllWISE Source Catalog
50+
allwise_p3as_mep AllWISE Multiepoch Photometry Table
51+
allwise_p3as_psr AllWISE Reject Table
5552
...
56-
...
57-
sdwfs_ch1_epoch3 SDWFS Aug '09 DR1.1 IRAC 3.6um-Selected 3x30sec Coadd, epoch 3 (Feb '08)
53+
wisegalhii WISE Catalog of Galactic HII Regions v2.2
54+
denis3 DENIS 3rd Release (Sep. 2005)
55+
5856

5957
Performing a cone search
6058
------------------------
@@ -74,25 +72,16 @@ entered as a string that is parsable by `~astropy.coordinates.Angle`.
7472
>>> table = Irsa.query_region("m31", catalog="fp_psc", spatial="Cone",
7573
... radius=2 * u.arcmin)
7674
>>> print(table)
77-
ra dec clon clat err_maj ... j_h h_k j_k id
78-
------- ------- ------------ ------------ ------- ... ----- ------ ------ ---
79-
10.685 41.248 00h42m44.45s 41d14m52.56s 0.14 ... 1.792 -0.821 0.971 0
80-
10.697 41.275 00h42m47.39s 41d16m30.25s 0.13 ... -- -- -- 1
81-
10.673 41.254 00h42m41.63s 41d15m15.66s 0.26 ... -- 1.433 -- 2
82-
10.671 41.267 00h42m41.10s 41d15m59.97s 0.17 ... -- -- -- 3
83-
10.684 41.290 00h42m44.11s 41d17m24.99s 0.19 ... 0.261 -1.484 -1.223 4
84-
10.692 41.290 00h42m46.08s 41d17m24.99s 0.18 ... -- -- 0.433 5
85-
10.716 41.260 00h42m51.77s 41d15m36.31s 0.13 ... 0.65 -- -- 6
86-
10.650 41.286 00h42m35.96s 41d17m08.48s 0.41 ... 1.205 -- -- 7
87-
... ... ... ... ... ... ... ... ... ...
88-
10.686 41.271 00h42m44.60s 41d16m14.16s 0.13 ... -- -- -- 768
89-
10.694 41.277 00h42m46.55s 41d16m36.13s 0.27 ... -- -- -- 769
90-
10.690 41.277 00h42m45.71s 41d16m36.54s 0.15 ... -- -- -- 770
91-
10.679 41.281 00h42m42.88s 41d16m51.62s 0.43 ... -- -- -- 771
92-
10.689 41.237 00h42m45.26s 41d14m13.32s 0.22 ... -- -- -- 772
93-
10.661 41.274 00h42m38.53s 41d16m24.76s 0.18 ... -- -- -- 773
94-
10.653 41.281 00h42m36.78s 41d16m52.98s 0.17 ... -- 0.795 -- 774
95-
75+
ra dec clon clat ... j_h h_k j_k
76+
deg deg ...
77+
---------- ---------- ------------ ------------ ... ----- ------ -----
78+
10.684737 41.269035 00h42m44.34s 41d16m08.53s ... 0.785 0.193 0.978
79+
10.685657 41.269550 00h42m44.56s 41d16m10.38s ... -- -- --
80+
... ... ... ... ... ... ... ...
81+
10.702501 41.299492 00h42m48.60s 41d17m58.17s ... -- -- --
82+
10.728661 41.273312 00h42m54.88s 41d16m23.92s ... -- -- --
83+
10.728869 41.265533 00h42m54.93s 41d15m55.92s ... 0.803 0.613 1.416
84+
Length = 500 rows
9685

9786

9887
The coordinates of the center may be specified rather than using the target
@@ -109,7 +98,18 @@ a string, as specified by `astropy.coordinates`:
10998
... -21.5733, unit=(u.deg,u.deg),
11099
... frame='galactic'),
111100
... catalog='fp_psc', radius='0d2m0s')
112-
>>> print(table) # doctest: +IGNORE_OUTPUT
101+
>>> print(table)
102+
ra dec clon clat ... angle j_h h_k j_k
103+
deg deg ... deg
104+
---------- ---------- ------------ ------------ ... ---------- ----- ----- -----
105+
10.684737 41.269035 00h42m44.34s 41d16m08.53s ... 10.37715 0.785 0.193 0.978
106+
10.683469 41.268585 00h42m44.03s 41d16m06.91s ... 259.028985 -- -- --
107+
10.685657 41.269550 00h42m44.56s 41d16m10.38s ... 43.199247 -- -- --
108+
... ... ... ... ... ... ... ... ...
109+
10.656898 41.294655 00h42m37.66s 41d17m40.76s ... 321.14224 1.237 -- --
110+
10.647116 41.286366 00h42m35.31s 41d17m10.92s ... 301.969315 -- -- --
111+
Length = 500 rows
112+
113113

114114
Performing a box search
115115
-----------------------
@@ -128,21 +128,19 @@ for cone search queries, above - so it may be set using the appropriate
128128
>>> table = Irsa.query_region("00h42m44.330s +41d16m07.50s",
129129
... catalog='fp_psc', spatial='Box',
130130
... width=5 * u.arcsec)
131-
WARNING: Coordinate string is being interpreted as an ICRS
132-
coordinate. [astroquery.irsa.core]
133131
>>> print(table)
134-
135-
ra dec clon clat err_maj ... j_h h_k j_k id
136-
------- ------- ------------ ------------ ------- ... ----- ----- ----- ---
137-
10.685 41.269 00h42m44.34s 41d16m08.53s 0.08 ... 0.785 0.193 0.978 0
132+
ra dec clon clat ... ext_key j_h h_k j_k
133+
deg deg ...
134+
---------- ---------- ------------ ------------ ... ------- ----- ----- -----
135+
10.684737 41.269035 00h42m44.34s 41d16m08.53s ... -- 0.785 0.193 0.978
138136

139137
Note that in this case we directly passed ICRS coordinates as a string to the
140138
:meth:`~astroquery.irsa.IrsaClass.query_region`.
141139

140+
142141
Queries over a polygon
143142
----------------------
144143

145-
146144
Polygon queries can be performed by setting ``spatial='Polygon'``. The search
147145
center is optional in this case. One additional parameter that must be set for
148146
these queries is ``polygon``. This is a list of coordinate pairs that define a
@@ -165,15 +163,16 @@ options is illustrated below:
165163
... coordinates.SkyCoord(ra=10.0, dec=10.0, unit=(u.deg, u.deg), frame='icrs')
166164
... ])
167165
>>> print(table)
168-
ra dec clon clat err_maj ... j_h h_k j_k id
169-
------- ------- ------------ ------------ ------- ... ----- ----- ----- ---
170-
10.016 10.099 00h40m03.77s 10d05m57.22s 0.1 ... 0.602 0.154 0.756 0
171-
10.031 10.063 00h40m07.44s 10d03m47.10s 0.19 ... 0.809 0.291 1.1 1
172-
10.037 10.060 00h40m08.83s 10d03m37.00s 0.11 ... 0.468 0.372 0.84 2
173-
10.060 10.085 00h40m14.39s 10d05m07.60s 0.23 ... 0.697 0.273 0.97 3
174-
10.016 10.038 00h40m03.80s 10d02m17.02s 0.09 ... 0.552 0.313 0.865 4
175-
10.011 10.094 00h40m02.68s 10d05m38.05s 0.23 ... 0.378 0.602 0.98 5
176-
10.006 10.018 00h40m01.33s 10d01m06.24s 0.16 ... 0.662 0.566 1.228 6
166+
ra dec clon clat ... ext_key j_h h_k j_k
167+
deg deg ...
168+
---------- ---------- ------------ ------------ ... ------- ----- ----- -----
169+
10.015839 10.038061 00h40m03.80s 10d02m17.02s ... -- 0.552 0.313 0.865
170+
10.015696 10.099228 00h40m03.77s 10d05m57.22s ... -- 0.602 0.154 0.756
171+
10.011170 10.093903 00h40m02.68s 10d05m38.05s ... -- 0.378 0.602 0.98
172+
10.031016 10.063082 00h40m07.44s 10d03m47.10s ... -- 0.809 0.291 1.1
173+
10.036776 10.060278 00h40m08.83s 10d03m37.00s ... -- 0.468 0.372 0.84
174+
10.059964 10.085445 00h40m14.39s 10d05m07.60s ... -- 0.697 0.273 0.97
175+
10.005549 10.018401 00h40m01.33s 10d01m06.24s ... -- 0.662 0.566 1.228
177176

178177
Another way to specify the polygon is directly as a list of tuples - each tuple
179178
is an ra, dec pair expressed in degrees:
@@ -185,35 +184,47 @@ is an ra, dec pair expressed in degrees:
185184
>>> table = Irsa.query_region("m31", catalog="fp_psc", spatial="Polygon",
186185
... polygon = [(10.1, 10.1), (10.0, 10.1), (10.0, 10.0)])
187186
>>> print(table)
188-
ra dec clon clat err_maj ... j_h h_k j_k id
189-
------- ------- ------------ ------------ ------- ... ----- ----- ----- ---
190-
10.016 10.099 00h40m03.77s 10d05m57.22s 0.1 ... 0.602 0.154 0.756 0
191-
10.031 10.063 00h40m07.44s 10d03m47.10s 0.19 ... 0.809 0.291 1.1 1
192-
10.037 10.060 00h40m08.83s 10d03m37.00s 0.11 ... 0.468 0.372 0.84 2
193-
10.060 10.085 00h40m14.39s 10d05m07.60s 0.23 ... 0.697 0.273 0.97 3
194-
10.016 10.038 00h40m03.80s 10d02m17.02s 0.09 ... 0.552 0.313 0.865 4
195-
10.011 10.094 00h40m02.68s 10d05m38.05s 0.23 ... 0.378 0.602 0.98 5
196-
10.006 10.018 00h40m01.33s 10d01m06.24s 0.16 ... 0.662 0.566 1.228 6
187+
ra dec clon clat ... ext_key j_h h_k j_k
188+
deg deg ...
189+
---------- ---------- ------------ ------------ ... ------- ----- ----- -----
190+
10.015839 10.038061 00h40m03.80s 10d02m17.02s ... -- 0.552 0.313 0.865
191+
10.015696 10.099228 00h40m03.77s 10d05m57.22s ... -- 0.602 0.154 0.756
192+
10.011170 10.093903 00h40m02.68s 10d05m38.05s ... -- 0.378 0.602 0.98
193+
10.031016 10.063082 00h40m07.44s 10d03m47.10s ... -- 0.809 0.291 1.1
194+
10.036776 10.060278 00h40m08.83s 10d03m37.00s ... -- 0.468 0.372 0.84
195+
10.059964 10.085445 00h40m14.39s 10d05m07.60s ... -- 0.697 0.273 0.97
196+
10.005549 10.018401 00h40m01.33s 10d01m06.24s ... -- 0.662 0.566 1.228
197+
197198

198199
Selecting Columns
199200
--------------------
200201

201-
The IRSA service allows to query either a subset of the default columns for a given table, or additional columns that are not present by default. This can be done by listing all the required columns separated by a comma (,) in a string with the ``selcols`` argument.
202+
The IRSA service allows to query either a subset of the default columns for
203+
a given table, or additional columns that are not present by default. This
204+
can be done by listing all the required columns separated by a comma (,) in
205+
a string with the ``selcols`` argument.
206+
207+
208+
An example where the AllWISE Source Catalog needs to be queried around the
209+
star HIP 12 with just the ra, dec and w1mpro columns would be:
202210

203-
An example where the AllWISE Source Catalog needs to be queried around the star HIP 12 with just the ra, dec and w1mpro columns would be:
204211

205212
.. code-block:: python
206213
.. doctest-remote-data::
207214

208215
>>> from astroquery.irsa import Irsa
209216
>>> table = Irsa.query_region("HIP 12", catalog="allwise_p3as_psd", spatial="Cone", selcols="ra,dec,w1mpro")
210217
>>> print(table)
211-
ra dec clon clat w1mpro dist angle id
212-
deg deg mag arcsec deg
213-
------- ------- ------------ ------------- ------ -------- ---------- ---
214-
0.041 -35.960 00h00m09.79s -35d57m36.94s 4.837 0.350806 245.442148 0
218+
ra dec clon clat w1mpro dist angle
219+
deg deg mag arcsec deg
220+
----------- ----------- ------------ ------------- ------- -------- ----------
221+
0.0407905 -35.9602605 00h00m09.79s -35d57m36.94s 4.837 0.350806 245.442148
222+
223+
A list of available columns for each catalog can be found at
224+
https://irsa.ipac.caltech.edu/holdings/catalogs.html. The "Long Form" button
225+
at the top of the column names table must be clicked to access a full list
226+
of all available columns.
215227

216-
A list of available columns for each catalog can be found at https://irsa.ipac.caltech.edu/holdings/catalogs.html. The "Long Form" button at the top of the column names table must be clicked to access a full list of all available columns.
217228

218229
Changing the precision of ascii output
219230
--------------------------------------
@@ -232,10 +243,11 @@ individual columns may be set to increase the precision.
232243
>>> table['ra'].format = '{:10.6f}'
233244
>>> table['dec'].format = '{:10.6f}'
234245
>>> print(table)
235-
ra dec clon clat w1mpro dist angle id
236-
deg deg mag arcs deg
237-
----------- ----------- ------------ ------------- ------ -------- ---------- ---
238-
0.0407905 -35.9602605 00h00m09.79s -35d57m36.94s 4.837 0.350806 245.442148 0
246+
ra dec clon clat w1mpro dist angle
247+
deg deg mag arcsec deg
248+
---------- ---------- ------------ ------------- ------- -------- ----------
249+
0.040791 -35.960260 00h00m09.79s -35d57m36.94s 4.837 0.350806 245.442148
250+
239251

240252
Other Configurations
241253
--------------------
@@ -247,7 +259,7 @@ change the setting only for the ongoing python session, you could also do:
247259
.. code-block:: python
248260
249261
>>> from astroquery.irsa import Irsa
250-
>>> Irsa.ROW_LIMIT = 1000 # value of new row limit here.
262+
>>> Irsa.ROW_LIMIT = 1000 # 1000 is the new value for row limit here.
251263
252264
253265
Reference/API

0 commit comments

Comments
 (0)