summaryrefslogtreecommitdiff
path: root/lib/polygon.py
diff options
context:
space:
mode:
authorlim <lim@stsci.edu>2012-06-27 12:49:54 -0400
committerlim <lim@stsci.edu>2012-06-27 12:49:54 -0400
commit274d8a03c34444abc0ddd0f2c6495f72ba6959c1 (patch)
treeab20e7c758d81d4e9394f6fab05b123ff9b3a4e7 /lib/polygon.py
parentd5f1fce2e7df93f76ed860b8ffe1f2a97599bd25 (diff)
downloadstsci.sphere-274d8a03c34444abc0ddd0f2c6495f72ba6959c1.tar.gz
lim updated existing doc and added skyline doc
git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/branches/sphere@17584 fe389314-cf27-0410-b35b-8c050e845b92 Former-commit-id: 1dbb501e8e1337077abc2595bf43226e34d57153
Diffstat (limited to 'lib/polygon.py')
-rw-r--r--lib/polygon.py13
1 files changed, 8 insertions, 5 deletions
diff --git a/lib/polygon.py b/lib/polygon.py
index 8047ab1..fd67042 100644
--- a/lib/polygon.py
+++ b/lib/polygon.py
@@ -115,12 +115,14 @@ class SphericalPolygon(object):
return self._inside
def to_radec(self):
- """Convert `SphericalPolygon` footprint to RA and DEC.
+ """
+ Convert `SphericalPolygon` footprint to RA and DEC.
Returns
-------
- List of RA and DEC pairs (in degrees) corresponding to
- `self.points`.
+ zip(ra,dec) : list of tuples
+ List of (*ra*, *dec*) pairs in degrees corresponding
+ to `points`.
"""
ra, dec = vector.vector_to_radec(self.points[:,0], self.points[:,1],
self.points[:,2], degrees=True)
@@ -314,7 +316,7 @@ class SphericalPolygon(object):
Parameters
----------
- preserve_order: bool
+ preserve_order : bool
Preserve original order? If `True`, polygon is
rotated around min point. If `False`, all points
are sorted in ascending order.
@@ -361,7 +363,8 @@ class SphericalPolygon(object):
Returns
-------
- `True` or `False`
+ is_eq : bool
+ `True` or `False`.
"""
self_n = len(self.points)