Skip to content

Commit 17512a5

Browse files
committed
added basic docs
1 parent d8b3e59 commit 17512a5

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

docs/higal/higal.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. doctest-skip-all
2+
3+
.. _astroquery.higal:
4+
5+
**************************************
6+
HiGal Image Cutout and Catalog service
7+
**************************************
8+
9+
Getting started
10+
===============
11+
12+
The HiGal image cutout service is a sub-service of the Space Science Data
13+
Center Sky Explorer (https://tools.ssdc.asi.it/). It enables image cutout
14+
queries and catalog queries.
15+
16+
An example catalog query:
17+
18+
.. python::
19+
>>> from astroquery.higal import HiGal
20+
>>> from astropy import units as u, coordinates
21+
>>> target = coordinates.SkyCoord(49.5, -0.3, frame='galactic', unit=(u.deg, u.deg))
22+
>>> result = HiGal.query_region(coordinates=target, radius=0.25*u.deg)
23+
>>> result
24+
<Table length=689>
25+
DEC DESIGNATION ERR_FINT ERR_FPEAK FINT FPEAK FWHMA FWHMB GLAT GLON NAME PA RA RMS_SURROUND rowid
26+
float64 str22 float64 float64 float64 float64 float64 float64 float64 float64 str10 float64 float64 float64 int64
27+
--------- ---------------------- -------- --------- -------- -------- ------- ------- --------- --------- ---------- ------- --------- ------------ -----
28+
14.335341 HIGALPB049.3443-0.4849 0.171 11.126 2.66513 203.692 22.77 17.43 -0.484918 49.344287 HIGAL_BLUE -74.4 290.95059 28.8882 5567
29+
14.358867 HIGALPB049.3808-0.5031 0.158 14.851 3.72149 425.767 15.18 17.28 -0.503143 49.380769 HIGAL_BLUE 64.1 290.98497 56.3716 5513
30+
...
31+
32+
33+
And an example image query:
34+
35+
.. python::
36+
>>> from astroquery.higal import HiGal
37+
>>> from astropy import units as u, coordinates
38+
>>> target = coordinates.SkyCoord(49.5, -0.3, frame='galactic', unit=(u.deg, u.deg))
39+
>>> result = HiGal.get_images(coordinates=target, radius=0.25*u.deg)
40+
[[<astropy.io.fits.hdu.image.PrimaryHDU object at 0xb15715a58>],
41+
[<astropy.io.fits.hdu.image.PrimaryHDU object at 0xb156fda58>],
42+
[<astropy.io.fits.hdu.image.PrimaryHDU object at 0xb1571af98>],
43+
[<astropy.io.fits.hdu.image.PrimaryHDU object at 0xb1523e978>],
44+
[<astropy.io.fits.hdu.image.PrimaryHDU object at 0xb15243be0>]]
45+
46+
47+
Reference/API
48+
=============
49+
50+
.. automodapi:: astroquery.higal
51+
:no-inheritance-diagram:

0 commit comments

Comments
 (0)