Skip to content

Reword a bit the contour docs. #12897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 27, 2018
Merged

Reword a bit the contour docs. #12897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 19 additions & 26 deletions lib/matplotlib/contour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1661,19 +1661,17 @@ def _initialize_x_y(self, z):

contour([X, Y,] Z, [levels], **kwargs)

:func:`~matplotlib.pyplot.contour` and
:func:`~matplotlib.pyplot.contourf` draw contour lines and
filled contours, respectively. Except as noted, function
signatures and return values are the same for both versions.

`.contour` and `.contourf` draw contour lines and filled contours,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should make Axes.contour point to Axes.contourf and pyplot.contour point to pyplot.contourf.

respectively. Except as noted, function signatures and return values
are the same for both versions.

Parameters
----------
X, Y : array-like, optional
The coordinates of the values in *Z*.

*X* and *Y* must both be 2-D with the same shape as *Z* (e.g.
created via :func:`numpy.meshgrid`), or they must both be 1-D such
created via `numpy.meshgrid`), or they must both be 1-D such
that ``len(X) == M`` is the number of columns in *Z* and
``len(Y) == N`` is the number of rows in *Z*.

Expand Down Expand Up @@ -1705,8 +1703,7 @@ def _initialize_x_y(self, z):
nearest those points are always masked out, other triangular
corners comprising three unmasked points are contoured as usual.

Defaults to ``rcParams['contour.corner_mask']``, which defaults to
``True``.
Defaults to :rc:`contour.corner_mask`, which defaults to ``True``.

colors : color string or sequence of colors, optional
The colors of the levels, i.e. the lines for `.contour` and the
Expand Down Expand Up @@ -1756,15 +1753,14 @@ def _initialize_x_y(self, z):
*None* in the rcParam is currently handled as 'lower'.

extent : (x0, x1, y0, y1), optional
If *origin* is not *None*, then *extent* is interpreted as
in :func:`matplotlib.pyplot.imshow`: it gives the outer
pixel boundaries. In this case, the position of Z[0,0]
is the center of the pixel, not a corner. If *origin* is
*None*, then (*x0*, *y0*) is the position of Z[0,0], and
(*x1*, *y1*) is the position of Z[-1,-1].
If *origin* is not *None*, then *extent* is interpreted as in
`.imshow`: it gives the outer pixel boundaries. In this case, the
position of Z[0,0] is the center of the pixel, not a corner. If
*origin* is *None*, then (*x0*, *y0*) is the position of Z[0,0],
and (*x1*, *y1*) is the position of Z[-1,-1].

This keyword is not active if *X* and *Y* are specified in
the call to contour.
This argument is ignored if *X* and *Y* are specified in the call
to contour.

locator : ticker.Locator subclass, optional
The locator is used to determine the contour levels if they
Expand Down Expand Up @@ -1830,20 +1826,17 @@ def _initialize_x_y(self, z):
Hatching is supported in the PostScript, PDF, SVG and Agg
backends only.


Notes
-----
1. :func:`~matplotlib.pyplot.contourf` differs from the MATLAB
version in that it does not draw the polygon edges.
To draw edges, add line contours with
calls to :func:`~matplotlib.pyplot.contour`.
1. `.contourf` differs from the MATLAB version in that it does not draw
the polygon edges. To draw edges, add line contours with calls to
`.contour`.

2. contourf fills intervals that are closed at the top; that
is, for boundaries *z1* and *z2*, the filled region is::
2. `.contourf` fills intervals that are closed at the top; that is, for
boundaries *z1* and *z2*, the filled region is::

z1 < Z <= z2

There is one exception: if the lowest boundary coincides with
the minimum value of the *Z* array, then that minimum value
will be included in the lowest interval.
except for the lowest interval, which is closed on both sides (i.e.
it includes the lowest value).
"""
43 changes: 17 additions & 26 deletions lib/matplotlib/tri/tricontour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,44 +94,38 @@ def _contour_args(self, args, kwargs):
def tricontour(ax, *args, **kwargs):
"""
Draw contours on an unstructured triangular grid.
:func:`~matplotlib.pyplot.tricontour` and
:func:`~matplotlib.pyplot.tricontourf` draw contour lines and
filled contours, respectively. Except as noted, function
signatures and return values are the same for both versions.

The triangulation can be specified in one of two ways; either::
`.tricontour` and `.tricontourf` draw contour lines and filled contours,
respectively. Except as noted, function signatures and return values are
the same for both versions.

tricontour(triangulation, ...)
The triangulation can be specified in one of two ways; either ::

where triangulation is a :class:`matplotlib.tri.Triangulation`
object, or
tricontour(triangulation, ...)

::
where *triangulation* is a `matplotlib.tri.Triangulation` object, or ::

tricontour(x, y, ...)
tricontour(x, y, triangles, ...)
tricontour(x, y, triangles=triangles, ...)
tricontour(x, y, mask=mask, ...)
tricontour(x, y, triangles, mask=mask, ...)

in which case a Triangulation object will be created. See
:class:`~matplotlib.tri.Triangulation` for a explanation of
these possibilities.
in which case a `.Triangulation` object will be created. See that class'
docstring for an explanation of these cases.

The remaining arguments may be::

tricontour(..., Z)

where *Z* is the array of values to contour, one per point
in the triangulation. The level values are chosen
automatically.
where *Z* is the array of values to contour, one per point in the
triangulation. The level values are chosen automatically.

::

tricontour(..., Z, N)

contour up to *N+1* automatically chosen contour levels
(*N* intervals).
contour up to *N+1* automatically chosen contour levels (*N* intervals).

::

Expand All @@ -154,8 +148,7 @@ def tricontour(ax, *args, **kwargs):
Use keyword args to control colors, linewidth, origin, cmap ... see
below for more details.

``C = tricontour(...)`` returns a
:class:`~matplotlib.contour.TriContourSet` object.
`.tricontour(...)` returns a `~matplotlib.contour.TriContourSet` object.

Optional keyword arguments:

Expand Down Expand Up @@ -226,7 +219,6 @@ def tricontour(ax, *args, **kwargs):
Override axis units by specifying an instance of a
:class:`matplotlib.units.ConversionInterface`.


tricontour-only keyword arguments:

*linewidths*: [ *None* | number | tuple of numbers ]
Expand Down Expand Up @@ -254,14 +246,13 @@ def tricontour(ax, *args, **kwargs):
*antialiased*: bool
enable antialiasing

Note: tricontourf fills intervals that are closed at the top; that
is, for boundaries *z1* and *z2*, the filled region is::
Note: `.tricontourf` fills intervals that are closed at the top; that is,
for boundaries *z1* and *z2*, the filled region is::

z1 < z <= z2
z1 < Z <= z2

There is one exception: if the lowest boundary coincides with
the minimum value of the *z* array, then that minimum value
will be included in the lowest interval.
except for the lowest interval, which is closed on both sides (i.e. it
includes the lowest value).
"""
kwargs['filled'] = False
return TriContourSet(ax, *args, **kwargs)
Expand Down