Skip to content

Commit 2f60071

Browse files
bsipoczbsipocz
committed
DOC: fixing API links
1 parent 12fd3f6 commit 2f60071

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

‎astroquery/heasarc/core.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ def query_mission_list(self, *, cache=True, get_query_payload=False):
187187
188188
This method is deprecated, and is included only for limited
189189
backward compatibility with the old astroquery.Heasarc that uses
190-
the Browse interface. Please use `~Heasarc.list_catalogs` instead.
190+
the Browse interface. Please use `list_catalogs` instead.
191191
192192
"""
193193
return self.list_catalogs(master=False)
@@ -238,7 +238,7 @@ def query_mission_cols(self, mission, *, cache=True,
238238
239239
NOTE: This method is deprecated, and is included only for limited
240240
backward compatibility with the old astroquery.Heasarc that uses
241-
the Browse interface. Please use `~Heasarc.list_columns` instead.
241+
the Browse interface. Please use `list_columns` instead.
242242
243243
Parameters
244244
----------
@@ -324,7 +324,7 @@ def query_region(self, position=None, catalog=None, radius=None, *,
324324
`astropy.units` may also be used. If None, a default value
325325
appropriate for the selected catalog is used. To see the default
326326
radius for the catalog, see
327-
`~astroquery.heasarc.Heasarc.get_default_radius`.
327+
`get_default_radius`.
328328
width : str, `~astropy.units.Quantity` object [Required for
329329
spatial == ``'box'``.]
330330
The string must be parsable by `~astropy.coordinates.Angle`. The

‎docs/heasarc/heasarc.rst

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ that have been approved but not observed.
3636
>>> from astropy.coordinates import SkyCoord
3737
>>> pos = SkyCoord.from_name('ngc 3783')
3838
>>> tab = Heasarc.query_region(pos, catalog='numaster')
39-
>>> tab = tab[tab['time'] > 0]
39+
>>> tab = tab[tab['time'] > 0]
4040
>>> tab.sort('time')
4141
>>> tab['name', 'obsid', 'ra', 'dec'][:3].pprint()
42-
name obsid ra dec
43-
deg deg
42+
name obsid ra dec
43+
deg deg
4444
-------- ----------- -------- --------
4545
NGC_3783 60101110002 174.7236 -37.7230
4646
NGC_3783 60101110004 174.7253 -37.7277
@@ -58,8 +58,8 @@ we use `~astropy.units.Quantity`:
5858
>>> tab = Heasarc.query_region(pos, catalog='chanmaster', radius=2*u.deg)
5959
>>> tab.sort('time')
6060
>>> tab['name', 'obsid', 'ra', 'dec'][:5].pprint(align='<')
61-
name obsid ra dec
62-
deg deg
61+
name obsid ra dec
62+
deg deg
6363
------------------------- ----- --------- --------
6464
B2 0755+37 858 119.61750 37.78667
6565
ABELL 611 3194 120.23708 36.05722
@@ -83,8 +83,8 @@ The list of returned columns can also be given as a comma-separated string to
8383
>>> tab = Heasarc.query_region(pos, catalog='chanmaster', radius=2*u.deg,
8484
... columns='obsid, name, time, pi')
8585
>>> tab[:5].pprint()
86-
obsid name time pi
87-
d
86+
obsid name time pi
87+
d
8888
----- ------------------------- ---------------- -------
8989
3194 ABELL 611 52216.7805324074 Allen
9090
858 B2 0755+37 51637.0090740741 Worrall
@@ -97,9 +97,9 @@ If you want all the columns returned, use ``columns='*'``
9797

9898
List Available Catalogs
9999
-----------------------
100-
The collection of available catalogs can be obtained by calling the `~astroquery.heasarc.HeasarcClass.list_catalogs`
100+
The collection of available catalogs can be obtained by calling the `~astroquery.heasarc.HeasarcClass.list_catalogs`
101101
method. In this example, we query the master catalogs only by passing ``master=True``.
102-
which is ``False`` by default (i.e. return all catalogs). `~astroquery.heasarc.HeasarcClass.list_catalogs` returns an
102+
which is ``False`` by default (i.e. return all catalogs). `~astroquery.heasarc.HeasarcClass.list_catalogs` returns an
103103
`~astropy.table.Table` with two columns containing the names and description of the available
104104
catalogs.
105105

@@ -108,15 +108,15 @@ catalogs.
108108
>>> from astroquery.heasarc import Heasarc
109109
>>> catalogs = Heasarc.list_catalogs(master=True)
110110
>>> catalogs.pprint(align='<')
111-
name description
111+
name description
112112
---------- -------------------------------------------------------------
113-
ascamaster ASCA Master Catalog
114-
chanmaster Chandra Observations
113+
ascamaster ASCA Master Catalog
114+
chanmaster Chandra Observations
115115
cmbmaster LAMBDA Cosmic Microwave Background Experiments Master Catalog
116116
...
117117

118-
If you do not know the name of the catalog you are looking for, you can use the ``keywords``
119-
parameter in `~astroquery.heasarc.HeasarcClass.list_catalogs`. For example, if you want to find all catalogs that
118+
If you do not know the name of the catalog you are looking for, you can use the ``keywords``
119+
parameter in `~astroquery.heasarc.HeasarcClass.list_catalogs`. For example, if you want to find all catalogs that
120120
are related to Chandra, you can do:
121121

122122
.. doctest-remote-data::
@@ -125,7 +125,7 @@ are related to Chandra, you can do:
125125
>>> catalogs = Heasarc.list_catalogs(keywords='chandra')
126126
>>> # list the first 10
127127
>>> catalogs[:10].pprint()
128-
name description
128+
name description
129129
---------- ----------------------------------------------------------------
130130
acceptcat Archive of Chandra Cluster Entropy Profile Tables (ACCEPT) Catal
131131
aegisx AEGIS-X Chandra Extended Groth Strip X-Ray Point Source Catalog
@@ -145,19 +145,19 @@ If you are interested only finding the master catalogs, you can also set ``maste
145145
>>> from astroquery.heasarc import Heasarc
146146
>>> catalog = Heasarc.list_catalogs(keywords='chandra', master=True)
147147
>>> catalog.pprint()
148-
name description
148+
name description
149149
---------- --------------------
150150
chanmaster Chandra Observations
151151

152-
Multiple keywords that are separated by space are joined with **AND**, so the
152+
Multiple keywords that are separated by space are joined with **AND**, so the
153153
following finds all the catalogs that have both 'xmm' and 'chandra' keywords:
154154

155155
.. doctest-remote-data::
156156

157157
>>> from astroquery.heasarc import Heasarc
158158
>>> catalog = Heasarc.list_catalogs(keywords='xmm chandra')
159159
>>> catalog.pprint()
160-
name description
160+
name description
161161
---------- ----------------------------------------------------------------
162162
gmrt1hxcsf Giant Metrewave Radio Telescope 1h XMM/Chandra Survey Fld 610-MH
163163
ic10xmmcxo IC 10 XMM-Newton and Chandra X-Ray Point Source Catalog
@@ -172,7 +172,7 @@ following for instance will find master catalogs that have keywords 'nicer' or '
172172
>>> from astroquery.heasarc import Heasarc
173173
>>> catalog = Heasarc.list_catalogs(keywords=['nicer', 'swift'], master=True)
174174
>>> catalog.pprint()
175-
name description
175+
name description
176176
---------- --------------------
177177
nicermastr NICER Master Catalog
178178
swiftmastr Swift Master Catalog
@@ -191,7 +191,7 @@ with those results.
191191
>>> tab = tab[tab['exposure'] > 0]
192192
>>> links = Heasarc.locate_data(tab[:2])
193193
>>> links['access_url'].pprint()
194-
access_url
194+
access_url
195195
---------------------------------------------------------------------
196196
https://heasarc.gsfc.nasa.gov/FTP/nicer/data/obs/2018_08//1100120101/
197197
https://heasarc.gsfc.nasa.gov/FTP/nicer/data/obs/2018_08//1100120102/
@@ -216,7 +216,7 @@ before being untarred.
216216

217217
Advanced Queries
218218
----------------
219-
Behind the scenes, `~astroquery.heasarc.HeasarcClass.query_region` constructs an query in the
219+
Behind the scenes, `~astroquery.heasarc.HeasarcClass.query_region` constructs an query in the
220220
Astronomical Data Query Language ADQL, which is powerful in constructing
221221
complex queries. Passing ``get_query_payload=True`` to `~astroquery.heasarc.HeasarcClass.query_region`
222222
returns the constructed ADQL query.
@@ -232,12 +232,12 @@ returns the constructed ADQL query.
232232
>>> query
233233
"SELECT * FROM xmmmaster WHERE CONTAINS(POINT('ICRS',ra,dec),CIRCLE('ICRS',120.0,38.0,2.0))=1"
234234
>>> # The query can be modified and then submitted using:
235-
>>> query = """SELECT ra,dec,name,obsid FROM xmmmaster
235+
>>> query = """SELECT ra,dec,name,obsid FROM xmmmaster
236236
... WHERE CONTAINS(POINT('ICRS',ra,dec),CIRCLE('ICRS',120.0,38.0,2.0))=1"""
237237
>>> tab = Heasarc.query_tap(query).to_table()
238238
>>> tab[:10].pprint()
239-
ra dec name obsid
240-
deg deg
239+
ra dec name obsid
240+
deg deg
241241
--------- -------- -------------------- ----------
242242
120.22707 36.04139 Abell 611 0781590301
243243
120.25583 36.04944 Abell 611 0781590501
@@ -268,7 +268,7 @@ for ``'box'`` and:
268268
>>> Heasarc.query_region(catalog='xmmmaster', spatial='polygon',
269269
polygon=[(226.2,10.6),(225.9,10.5),(225.8,10.2),(226.2,10.3)])
270270

271-
for ``'polygon'``.
271+
for ``'polygon'``.
272272

273273
List Catalog Columns
274274
--------------------
@@ -281,14 +281,14 @@ in the XMM master catalog ``xmmmaster``:
281281
>>> columns = Heasarc.list_columns(catalog_name='suzamaster')
282282
>>> columns.sort('name')
283283
>>> columns[:10].pprint(align='<')
284-
name description unit
284+
name description unit
285285
--------------- ---------------------------------------- ------
286286
dec Declination (Pointing Position) degree
287-
exposure Effective Total Observation Exposure (s) s
288-
name Designation of the Pointed Source
289-
obsid Unique Observation/Sequence Number
290-
processing_date Date of Processing mjd
291-
public_date Public Date mjd
287+
exposure Effective Total Observation Exposure (s) s
288+
name Designation of the Pointed Source
289+
obsid Unique Observation/Sequence Number
290+
processing_date Date of Processing mjd
291+
public_date Public Date mjd
292292
ra Right Ascension (Pointing Position) degree
293293

294294
Reference/API

0 commit comments

Comments
 (0)