File: limitations.rst

package info (click to toggle)
contourpy 1.3.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,688 kB
  • sloc: python: 7,998; cpp: 6,241; makefile: 13
file content (45 lines) | stat: -rw-r--r-- 1,528 bytes parent folder | download | duplicates (2)
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
.. _limitations:

Limitations
-----------

Duplicate contour points
^^^^^^^^^^^^^^^^^^^^^^^^

It is possible for calculated contour lines and filled polygons to contain identical adjacent
points. This can occur when contouring a z-level that exactly matches the value at a grid point.

As an example, consider calculating contour lines at ``z=0.1`` on a grid of a single quad with one
corner at ``z=0`` and the other three at ``z=1``:

  >>> from contourpy import contour_generator
  >>> cont_gen = contour_generator(z=[[0, 1], [1, 1]])
  >>> cont_gen.lines(0.1)
  [array([[0. , 0.1],
          [0.1, 0. ]])]

The returned contour line has two points, from ``(0, 0.1)`` to ``(0.1, 0)``.

If you contour a z-value of ``z=0.01``:

  >>> cont_gen.lines(0.1)
  [array([[0.  , 0.01],
          [0.01, 0.  ]])]

the contoured points are correspondingly closer to the ``z=0`` corner.

If the contoured z-level is ``0``, exactly matching the z-value of the corner:

  >>> cont_gen.lines(0)
  [array([[0., 0.],
          [0., 0.]])]

then the returned contour line still has two points but they are identical, exactly the same as the
corner's ``(x, y)`` location.

Similar applies to filled contours so that it is possible for a filled contour polygon to have
multiple duplicate points and zero area.

Depending on what you are doing with the calculated contours, this may or may not be a problem.
If you are using them with `Shapely`_ for example, they might be considered invalid; see
:ref:`shapely_invalid` for how to deal with this.