blob: 378986c5129dab65a78f5d6e6cb1be536abbc1ae (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

 a/README.rst 20190222 12:38:47.000000000 +0800
+++ b/README.rst 20190224 15:06:53.785650230 +0800
@@ 93,12 +93,14 @@
What is the orientation?
^^^^^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: spherical_geometry.polygon
+
The correctness of several of the algorithms using polygons depends on
a consistent orientation of the points defining it. That is, the points
should have a clockwise order. When creating a new spherical polygon,
the order of the points defining a polygon will be reversed if they are
not in clockwise order. The method `SphericalPolygon.is_clockwise`is
used to est if the points are in clockwise order. It takes two
+not in clockwise order. The method `SphericalPolygon.is_clockwise` is
+used to test if the points are in clockwise order. It takes two
successive sides and computes the normal vector to the sides. If the
normal vector points inward towards the center of the sphere, the two
sides are counter clockwise. If the normal vector points outward, the
@@ 170,7 +172,7 @@
`~SphericalPolygon.multi_intersection`: Return a new polygon that
is the intersection of two or more polygons.
  `~SphericalPolygon.overlap`: Determine how much a given polygon
+  `~SingleSphericalPolygon.overlap`: Determine how much a given polygon
overlaps another.
 `~SphericalPolygon.to_radec`: Convert (*x*, *y*, *z*) points in the
