You are reading documentation for the unreleased version of Matplotlib. Try searching for the released version of this page instead?
Version 2.1.1.post1094+g835fdc5
matplotlib
Fork me on GitHub

Table Of Contents

This Page

contour

matplotlib.contour

These are classes to support contour plotting and labelling for the Axes class.

class matplotlib.contour.ClabelText(x=0, y=0, text='', color=None, verticalalignment='baseline', horizontalalignment='left', multialignment=None, fontproperties=None, rotation=None, linespacing=None, rotation_mode=None, usetex=None, wrap=False, **kwargs)

Bases: matplotlib.text.Text

Unlike the ordinary text, the get_rotation returns an updated angle in the pixel coordinate assuming that the input rotation is an angle in data coordinate (or whatever transform set).

Create a Text instance at x, y with string text.

Valid kwargs are

Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha float (0.0 transparent through 1.0 opaque)
animated bool
backgroundcolor any matplotlib color
bbox FancyBboxPatch prop dict
clip_box a matplotlib.transforms.Bbox instance
clip_on bool
clip_path [ (Path, Transform) | Patch | None ]
color any matplotlib color
contains a callable function
family or fontfamily or fontname or name [FONTNAME | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ | ‘monospace’ ]
figure a Figure instance
fontproperties or font_properties a matplotlib.font_manager.FontProperties instance
gid an id string
horizontalalignment or ha [ ‘center’ | ‘right’ | ‘left’ ]
label object
linespacing float (multiple of font size)
multialignment or ma [‘left’ | ‘right’ | ‘center’ ]
path_effects AbstractPathEffect
picker [None | bool | float | callable]
position (x,y)
rasterized bool or None
rotation [ angle in degrees | ‘vertical’ | ‘horizontal’ ]
rotation_mode [ None | “default” | “anchor” ]
size or fontsize [size in points | ‘xx-small’ | ‘x-small’ | ‘small’ | ‘medium’ | ‘large’ | ‘x-large’ | ‘xx-large’ ]
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
stretch or fontstretch [a numeric value in range 0-1000 | ‘ultra-condensed’ | ‘extra-condensed’ | ‘condensed’ | ‘semi-condensed’ | ‘normal’ | ‘semi-expanded’ | ‘expanded’ | ‘extra-expanded’ | ‘ultra-expanded’ ]
style or fontstyle [ ‘normal’ | ‘italic’ | ‘oblique’]
text string or anything printable with ‘%s’ conversion.
transform Transform
url a url string
usetex bool or None
variant or fontvariant [ ‘normal’ | ‘small-caps’ ]
verticalalignment or va [ ‘center’ | ‘top’ | ‘bottom’ | ‘baseline’ ]
visible bool
weight or fontweight [a numeric value in range 0-1000 | ‘ultralight’ | ‘light’ | ‘normal’ | ‘regular’ | ‘book’ | ‘medium’ | ‘roman’ | ‘semibold’ | ‘demibold’ | ‘demi’ | ‘bold’ | ‘heavy’ | ‘extra bold’ | ‘black’ ]
wrap bool
x float
y float
zorder float
get_rotation()
class matplotlib.contour.ContourLabeler

Bases: object

Mixin to provide labelling capability to ContourSet

add_label(x, y, rotation, lev, cvalue)

Add contour label using Text class.

add_label_clabeltext(x, y, rotation, lev, cvalue)

Add contour label using ClabelText class.

add_label_near(x, y, inline=True, inline_spacing=5, transform=None)

Add a label near the point (x, y). If transform is None (default), (x, y) is in data coordinates; if transform is False, (x, y) is in display coordinates; otherwise, the specified transform will be used to translate (x, y) into display coordinates.

inline:
controls whether the underlying contour is removed or not. Default is True.
inline_spacing:
space in pixels to leave on each side of label when placing inline. Defaults to 5. This spacing will be exact for labels at locations where the contour is straight, less so for labels on curved contours.
calc_label_rot_and_inline(slc, ind, lw, lc=None, spacing=5)

This function calculates the appropriate label rotation given the linecontour coordinates in screen units, the index of the label location and the label width.

It will also break contour and calculate inlining if lc is not empty (lc defaults to the empty list if None). spacing is the space around the label in pixels to leave empty.

Do both of these tasks at once to avoid calling mlab.path_length multiple times, which is relatively costly.

The method used here involves calculating the path length along the contour in pixel coordinates and then looking approximately label width / 2 away from central point to determine rotation and then to break contour if desired.

clabel(*args, **kwargs)

Label a contour plot.

Call signature:

clabel(cs, **kwargs)

Adds labels to line contours in cs, where cs is a ContourSet object returned by contour.

clabel(cs, v, **kwargs)

only labels contours listed in v.

Parameters:

fontsize : string or float, optional

Size in points or relative size e.g., ‘smaller’, ‘x-large’. See Text.set_size for accepted string values.

colors :

Color of each label

  • if None, the color of each label matches the color of the corresponding contour
  • if one string color, e.g., colors = ‘r’ or colors = ‘red’, all labels will be plotted in this color
  • if a tuple of matplotlib color args (string, float, rgb, etc), different labels will be plotted in different colors in the order specified

inline : bool, optional

If True the underlying contour is removed where the label is placed. Default is True.

inline_spacing : float, optional

Space in pixels to leave on each side of label when placing inline. Defaults to 5.

This spacing will be exact for labels at locations where the contour is straight, less so for labels on curved contours.

fmt : string or dict, optional

A format string for the label. Default is ‘%1.3f’

Alternatively, this can be a dictionary matching contour levels with arbitrary strings to use for each contour level (i.e., fmt[level]=string), or it can be any callable, such as a Formatter instance, that returns a string when called with a numeric contour level.

manual : bool or iterable, optional

If True, contour labels will be placed manually using mouse clicks. Click the first button near a contour to add a label, click the second button (or potentially both mouse buttons at once) to finish adding labels. The third button can be used to remove the last label added, but only if labels are not inline. Alternatively, the keyboard can be used to select label locations (enter to end label placement, delete or backspace act like the third mouse button, and any other key will select a label location).

manual can also be an iterable object of x,y tuples. Contour labels will be created as if mouse is clicked at each x,y positions.

rightside_up : bool, optional

If True, label rotations will always be plus or minus 90 degrees from level. Default is True.

use_clabeltext : bool, optional

If True, ClabelText class (instead of Text) is used to create labels. ClabelText recalculates rotation angles of texts during the drawing time, therefore this can be used if aspect of the axes changes. Default is False.

get_label_coords(distances, XX, YY, ysize, lw)

Return x, y, and the index of a label location.

Labels are plotted at a location with the smallest deviation of the contour from a straight line unless there is another label nearby, in which case the next best place on the contour is picked up. If all such candidates are rejected, the beginning of the contour is chosen.

get_label_width(lev, fmt, fsize)

Return the width of the label in points.

get_real_label_width(lev, fmt, fsize)

Deprecated since version 2.2: The get_real_label_width function was deprecated in version 2.2.

This computes actual onscreen label width. This uses some black magic to determine onscreen extent of non-drawn label. This magic may not be very robust.

This method is not being used, and may be modified or removed.

get_text(lev, fmt)

get the text of the label

labels(inline, inline_spacing)
locate_label(linecontour, labelwidth)

Find good place to draw a label (relatively flat part of the contour).

pop_label(index=-1)

Defaults to removing last label, but any index can be supplied

print_label(linecontour, labelwidth)

Return False if contours are too short for a label.

set_label_props(label, text, color)

set the label properties - color, fontsize, text

too_close(x, y, lw)

Return True if a label is already near this location.

class matplotlib.contour.ContourSet(ax, *args, **kwargs)

Bases: matplotlib.cm.ScalarMappable, matplotlib.contour.ContourLabeler

Store a set of contour lines or filled regions.

User-callable method: clabel

Attributes

ax: The axes object in which the contours are drawn.
collections: A silent_list of LineCollections or PolyCollections.
levels: Contour levels.
layers: Same as levels for line contours; half-way between levels for filled contours. See _process_colors().

Draw contour lines or filled regions, depending on whether keyword arg filled is False (default) or True.

The first three arguments must be:

ax: axes object.

levels: [level0, level1, …, leveln]
A list of floating point numbers indicating the contour levels.
allsegs: [level0segs, level1segs, …]

List of all the polygon segments for all the levels. For contour lines len(allsegs) == len(levels), and for filled contour regions len(allsegs) = len(levels)-1. The lists should look like:

level0segs = [polygon0, polygon1, ...]
polygon0 = array_like [[x0,y0], [x1,y1], ...]
allkinds: None or [level0kinds, level1kinds, …]

Optional list of all the polygon vertex kinds (code types), as described and used in Path. This is used to allow multiply- connected paths such as holes within filled polygons. If not None, len(allkinds) == len(allsegs). The lists should look like:

level0kinds = [polygon0kinds, ...]
polygon0kinds = [vertexcode0, vertexcode1, ...]

If allkinds is not None, usually all polygons for a particular contour level are grouped together so that level0segs = [polygon0] and level0kinds = [polygon0kinds].

Keyword arguments are as described in the docstring of contour.

changed()
find_nearest_contour(x, y, indices=None, pixel=True)

Finds contour that is closest to a point. Defaults to measuring distance in pixels (screen space - useful for manual contour labeling), but this can be controlled via a keyword argument.

Returns a tuple containing the contour, segment, index of segment, x & y of segment point and distance to minimum point.

Optional keyword arguments:

indices:
Indexes of contour levels to consider when looking for nearest point. Defaults to using all levels.
pixel:
If True, measure distance in pixel space, if not, measure distance in axes space. Defaults to True.
get_alpha()

returns alpha to be applied to all ContourSet artists

get_transform()

Return the Transform instance used by this ContourSet.

legend_elements(variable_name='x', str_format=<class 'str'>)

Return a list of artist and labels suitable for passing through to plt.legend() which represent this ContourSet.

Args:

variable_name: the string used inside the inequality used
on the labels

str_format: function used to format the numbers in the labels

set_alpha(alpha)

sets alpha for all ContourSet artists

class matplotlib.contour.QuadContourSet(ax, *args, **kwargs)

Bases: matplotlib.contour.ContourSet

Create and store a set of contour lines or filled regions.

User-callable method: clabel()

Attributes

ax: The axes object in which the contours are drawn.
collections: A silent_list of LineCollections or PolyCollections.
levels: Contour levels.
layers: Same as levels for line contours; half-way between levels for filled contours. See _process_colors() method.

Draw contour lines or filled regions, depending on whether keyword arg filled is False (default) or True.

The first three arguments must be:

ax: axes object.

levels: [level0, level1, …, leveln]
A list of floating point numbers indicating the contour levels.
allsegs: [level0segs, level1segs, …]

List of all the polygon segments for all the levels. For contour lines len(allsegs) == len(levels), and for filled contour regions len(allsegs) = len(levels)-1. The lists should look like:

level0segs = [polygon0, polygon1, ...]
polygon0 = array_like [[x0,y0], [x1,y1], ...]
allkinds: None or [level0kinds, level1kinds, …]

Optional list of all the polygon vertex kinds (code types), as described and used in Path. This is used to allow multiply- connected paths such as holes within filled polygons. If not None, len(allkinds) == len(allsegs). The lists should look like:

level0kinds = [polygon0kinds, ...]
polygon0kinds = [vertexcode0, vertexcode1, ...]

If allkinds is not None, usually all polygons for a particular contour level are grouped together so that level0segs = [polygon0] and level0kinds = [polygon0kinds].

Keyword arguments are as described in the docstring of contour.