Add example

hipspy · Jun 6, 2017 · fa83213 · fa83213
1 parent 5de3e05
commit fa83213
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/hips/utils/healpix.py b/hips/utils/healpix.py
@@ -31,6 +31,14 @@ def boundaries(nside: int, pix: int, nest: bool=False) -> tuple:
     -------
     theta, phi : float, array
         Returns the angle (theta and phi) in radians
+
+    Examples
+    -------
+    nside = 8
+    pix = 450
+    theta, phi = boundaries(nside, pix, nest=True)
+
+    radec = SkyCoord(ra=phi, dec=np.pi/2 - theta, unit='radian', frame='icrs')
     """
 
     boundary_coords = healpy.boundaries(nside, pix, nest=nest)