matplotlib.github.com/3.1.3/api/contour_api.html at main · matplotlib/matplotlib.github.com

829 lines (776 loc) · 68.8 KB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>matplotlib.contour &mdash; Matplotlib 3.1.3 documentation</title>
    <link rel="stylesheet" href="../_static/mpl.css?v3.1.3-2-g782f6ef56"
type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
    <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
    <link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
    <link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../_static/jquery.js"></script>
        <script type="text/javascript" src="../_static/underscore.js"></script>
        <script type="text/javascript" src="../_static/doctools.js"></script>
        <script type="text/javascript" src="../_static/language_data.js"></script>
        <script type="text/javascript" src="../_static/clipboard.min.js"></script>
        <script type="text/javascript" src="../_static/copybutton.js"></script>
        <script type="text/javascript">var copybuttonSkipText = '>>> ';</script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Matplotlib 3.1.3 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html"
    <link rel="search" title="Search" href="../search.html"
    <link rel="top" title="Matplotlib 3.1.3 documentation" href="../index.html" />
    <link rel="up" title="API Overview" href="index.html" />
    <link rel="next" title="matplotlib.dates" href="dates_api.html" />
    <link rel="prev" title="matplotlib.container" href="container_api.html" />
    <link rel="canonical" href="https://matplotlib.org/stable/api/contour_api.html" />
    <script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.1.3).  For the latest version see <a href="https://matplotlib.org/stable/api/contour_api.html">https://matplotlib.org/stable/api/contour_api.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
    <div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.1.3</span></div>
    <img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
    <nav class="main-nav">
        <ul>
            <li><a href="../users/installing.html">Installation</a></li>
            <li><a href="../contents.html">Documentation</a></li>
            <li><a href="../gallery/index.html">Examples</a></li>
            <li><a href="../tutorials/index.html">Tutorials</a></li>
            <li><a href="../devel/index.html">Contributing</a></li>
            <li class="nav-right">
                <form class="search" action="../search.html" method="get">
                <input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
                </form>
            </li>
        </ul>
     </nav>
    <div class="related">
      <h3>Navigation</h3>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="dates_api.html" title="matplotlib.dates"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="container_api.html" title="matplotlib.container"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">home</a>|&nbsp;</li>
        <li><a href="../contents.html">contents</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">API Overview</a> &raquo;</li> 
      </ul>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
  <li><a href="../contents.html">Documentation overview</a><ul>
  <li><a href="index.html">API Overview</a><ul>
      <li>Previous: <a href="container_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.container</span></code></a></li>
      <li>Next: <a href="dates_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.dates</span></code></a></li>
  </ul></li>
  </ul></li>
  <div id="sidebar-pagesource" role="note" aria-label="source link"
    style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
  <a href="../_sources/api/contour_api.rst.txt"
     style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
        </div>
      </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
  <div class="section" id="module-matplotlib.contour">
<span id="matplotlib-contour"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.contour</span></code><a class="headerlink" href="#module-matplotlib.contour" title="Permalink to this headline">¶</a></h1>
<p>These are classes to support contour plotting and labelling for the Axes class.</p>
<dl class="class">
<dt id="matplotlib.contour.ClabelText">
<em class="property">class </em><code class="descclassname">matplotlib.contour.</code><code class="descname">ClabelText</code><span class="sig-paren">(</span><em>x=0</em>, <em>y=0</em>, <em>text=''</em>, <em>color=None</em>, <em>verticalalignment='baseline'</em>, <em>horizontalalignment='left'</em>, <em>multialignment=None</em>, <em>fontproperties=None</em>, <em>rotation=None</em>, <em>linespacing=None</em>, <em>rotation_mode=None</em>, <em>usetex=None</em>, <em>wrap=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ClabelText"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ClabelText" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.text.Text</span></code></a></p>
<p>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).</p>
<p>Create a <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a> instance at <em>x</em>, <em>y</em> with string <em>text</em>.</p>
<p>Valid kwargs are</p>
<blockquote>
<div><table border="1" class="property-table docutils">
<col width="32%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">agg_filter</span></code></a></td>
<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate"><span class="pre">alpha</span></code></a></td>
<td>float</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate"><span class="pre">animated</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_backgroundcolor" title="matplotlib.text.Text.set_backgroundcolor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">backgroundcolor</span></code></a></td>
<td>color</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_bbox" title="matplotlib.text.Text.set_bbox"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bbox</span></code></a></td>
<td>dict with properties for <a class="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">patches.FancyBboxPatch</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_box" title="matplotlib.text.Text.set_clip_box"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_box</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a></td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_on" title="matplotlib.text.Text.set_clip_on"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_on</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_path" title="matplotlib.text.Text.set_clip_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_path</span></code></a></td>
<td>[(<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a>) | <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Patch</span></code></a> | None]</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_color" title="matplotlib.text.Text.set_color"><code class="xref py py-meth docutils literal notranslate"><span class="pre">color</span></code></a> or c</td>
<td>color</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate"><span class="pre">contains</span></code></a></td>
<td>callable</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate"><span class="pre">figure</span></code></a></td>
<td><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontfamily" title="matplotlib.text.Text.set_fontfamily"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontfamily</span></code></a> or family</td>
<td>{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontproperties" title="matplotlib.text.Text.set_fontproperties"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontproperties</span></code></a> or font_properties</td>
<td><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontsize" title="matplotlib.text.Text.set_fontsize"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontsize</span></code></a> or size</td>
<td>{size in points, 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontstretch" title="matplotlib.text.Text.set_fontstretch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontstretch</span></code></a> or stretch</td>
<td>{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontstyle" title="matplotlib.text.Text.set_fontstyle"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontstyle</span></code></a> or style</td>
<td>{'normal', 'italic', 'oblique'}</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontvariant" title="matplotlib.text.Text.set_fontvariant"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontvariant</span></code></a> or variant</td>
<td>{'normal', 'small-caps'}</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontweight" title="matplotlib.text.Text.set_fontweight"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontweight</span></code></a> or weight</td>
<td>{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_gid.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal notranslate"><span class="pre">gid</span></code></a></td>
<td>str</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_horizontalalignment" title="matplotlib.text.Text.set_horizontalalignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">horizontalalignment</span></code></a> or ha</td>
<td>{'center', 'right', 'left'}</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_in_layout.html#matplotlib.artist.Artist.set_in_layout" title="matplotlib.artist.Artist.set_in_layout"><code class="xref py py-meth docutils literal notranslate"><span class="pre">in_layout</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate"><span class="pre">label</span></code></a></td>
<td>object</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_linespacing" title="matplotlib.text.Text.set_linespacing"><code class="xref py py-meth docutils literal notranslate"><span class="pre">linespacing</span></code></a></td>
<td>float (multiple of font size)</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_multialignment" title="matplotlib.text.Text.set_multialignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">multialignment</span></code></a> or ma</td>
<td>{'left', 'right', 'center'}</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate"><span class="pre">path_effects</span></code></a></td>
<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbstractPathEffect</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate"><span class="pre">picker</span></code></a></td>
<td>None or bool or float or callable</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_position" title="matplotlib.text.Text.set_position"><code class="xref py py-meth docutils literal notranslate"><span class="pre">position</span></code></a></td>
<td>(float, float)</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rasterized</span></code></a></td>
<td>bool or None</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_rotation" title="matplotlib.text.Text.set_rotation"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotation</span></code></a></td>
<td>{angle in degrees, 'vertical', 'horizontal'}</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_rotation_mode" title="matplotlib.text.Text.set_rotation_mode"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotation_mode</span></code></a></td>
<td>{None, 'default', 'anchor'}</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sketch_params</span></code></a></td>
<td>(scale: float, length: float, randomness: float)</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_snap.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">snap</span></code></a></td>
<td>bool or None</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_text" title="matplotlib.text.Text.set_text"><code class="xref py py-meth docutils literal notranslate"><span class="pre">text</span></code></a></td>
<td>object</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a></td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_url.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">url</span></code></a></td>
<td>str</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_usetex" title="matplotlib.text.Text.set_usetex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">usetex</span></code></a></td>
<td>bool or None</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_verticalalignment" title="matplotlib.text.Text.set_verticalalignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">verticalalignment</span></code></a> or va</td>
<td>{'center', 'top', 'bottom', 'baseline', 'center_baseline'}</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate"><span class="pre">visible</span></code></a></td>
<td>bool</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_wrap" title="matplotlib.text.Text.set_wrap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">wrap</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_x" title="matplotlib.text.Text.set_x"><code class="xref py py-meth docutils literal notranslate"><span class="pre">x</span></code></a></td>
<td>float</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_y" title="matplotlib.text.Text.set_y"><code class="xref py py-meth docutils literal notranslate"><span class="pre">y</span></code></a></td>
<td>float</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">zorder</span></code></a></td>
<td>float</td>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.contour.ClabelText.get_rotation">
<code class="descname">get_rotation</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ClabelText.get_rotation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ClabelText.get_rotation" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the text angle as float in degrees.</p>
<dl class="class">
<dt id="matplotlib.contour.ContourLabeler">
<em class="property">class </em><code class="descclassname">matplotlib.contour.</code><code class="descname">ContourLabeler</code><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Mixin to provide labelling capability to <a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ContourSet</span></code></a>.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.add_label">
<code class="descname">add_label</code><span class="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em>, <em>rotation</em>, <em>lev</em>, <em>cvalue</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.add_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Add contour label using <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a> class.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.add_label_clabeltext">
<code class="descname">add_label_clabeltext</code><span class="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em>, <em>rotation</em>, <em>lev</em>, <em>cvalue</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.add_label_clabeltext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label_clabeltext" title="Permalink to this definition">¶</a></dt>
<dd><p>Add contour label using <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClabelText</span></code></a> class.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.add_label_near">
<code class="descname">add_label_near</code><span class="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em>, <em>inline=True</em>, <em>inline_spacing=5</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.add_label_near"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label_near" title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>x, y</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><p class="first last">The approximate location of the label.</p>
<dt><strong>inline</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional, default: True</span></dt>
<dd><p class="first last">If <em>True</em> remove the segment of the contour beneath the label.</p>
<dt><strong>inline_spacing</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int, optional, default: 5</span></dt>
<dd><p class="first last">Space in pixels to leave on each side of label when placing
inline. This spacing will be exact for labels at locations where
the contour is straight, less so for labels on curved contours.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.calc_label_rot_and_inline">
<code class="descname">calc_label_rot_and_inline</code><span class="sig-paren">(</span><em>self</em>, <em>slc</em>, <em>ind</em>, <em>lw</em>, <em>lc=None</em>, <em>spacing=5</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.calc_label_rot_and_inline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.calc_label_rot_and_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>This function calculates the appropriate label rotation given
the linecontour coordinates in screen units, the index of the
label location and the label width.</p>
<p>It will also break contour and calculate inlining if <em>lc</em> is
not empty (lc defaults to the empty list if None).  <em>spacing</em>
is the space around the label in pixels to leave empty.</p>
<p>Do both of these tasks at once to avoid calculating path lengths
multiple times, which is relatively costly.</p>
<p>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.</p>
<dl class="attribute">
<dt id="matplotlib.contour.ContourLabeler.cl">
<code class="descname">cl</code><a class="headerlink" href="#matplotlib.contour.ContourLabeler.cl" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.contour.ContourLabeler.cl_cvalues">
<code class="descname">cl_cvalues</code><a class="headerlink" href="#matplotlib.contour.ContourLabeler.cl_cvalues" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.contour.ContourLabeler.cl_xy">
<code class="descname">cl_xy</code><a class="headerlink" href="#matplotlib.contour.ContourLabeler.cl_xy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.clabel">
<code class="descname">clabel</code><span class="sig-paren">(</span><em>self</em>, <em>*args</em>, <em>fontsize=None</em>, <em>inline=True</em>, <em>inline_spacing=5</em>, <em>fmt='%1.3f'</em>, <em>colors=None</em>, <em>use_clabeltext=False</em>, <em>manual=False</em>, <em>rightside_up=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.clabel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.clabel" title="Permalink to this definition">¶</a></dt>
<dd><p>Label a contour plot.</p>
<p>Call signature:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">clabel</span><span class="p">(</span><span class="n">cs</span><span class="p">,</span> <span class="p">[</span><span class="n">levels</span><span class="p">,]</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
<p>Adds labels to line contours in <em>cs</em>, where <em>cs</em> is a
<a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContourSet</span></code></a> object returned by
<code class="docutils literal notranslate"><span class="pre">contour()</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>cs</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ContourSet</span></code></a></span></dt>
<dd><p class="first last">The ContourSet to label.</p>
<dt><strong>levels</strong> <span class="classifier-delimiter">:</span> <span class="classifier">array-like, optional</span></dt>
<dd><p class="first last">A list of level values, that should be labeled. The list must be
a subset of <code class="docutils literal notranslate"><span class="pre">cs.levels</span></code>. If not given, all levels are labeled.</p>
<dt><strong>fontsize</strong> <span class="classifier-delimiter">:</span> <span class="classifier">string or float, optional</span></dt>
<dd><p class="first last">Size in points or relative size e.g., 'smaller', 'x-large'.
See <a class="reference internal" href="text_api.html#matplotlib.text.Text.set_size" title="matplotlib.text.Text.set_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text.set_size</span></code></a> for accepted string values.</p>
<dt><strong>colors</strong> <span class="classifier-delimiter">:</span> <span class="classifier">color-spec, optional</span></dt>
<dd><p class="first">The label colors:</p>
<ul class="last simple">
<li>If <em>None</em>, the color of each label matches the color of
the corresponding contour.</li>
<li>If one string color, e.g., <em>colors</em> = 'r' or <em>colors</em> =
'red', all labels will be plotted in this color.</li>
<li>If a tuple of matplotlib color args (string, float, rgb, etc),
different labels will be plotted in different colors in the order
specified.</li>
<dt><strong>inline</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd><p class="first last">If <code class="docutils literal notranslate"><span class="pre">True</span></code> the underlying contour is removed where the label is
placed. Default is <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<dt><strong>inline_spacing</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first">Space in pixels to leave on each side of label when
placing inline. Defaults to 5.</p>
<p class="last">This spacing will be exact for labels at locations where the
contour is straight, less so for labels on curved contours.</p>
<dt><strong>fmt</strong> <span class="classifier-delimiter">:</span> <span class="classifier">string or dict, optional</span></dt>
<dd><p class="first">A format string for the label. Default is '%1.3f'</p>
<p class="last">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 <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatter</span></code></a> instance, that
returns a string when called with a numeric contour level.</p>
<dt><strong>manual</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool or iterable, optional</span></dt>
<dd><p class="first">If <code class="docutils literal notranslate"><span class="pre">True</span></code>, 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).</p>
<p class="last"><em>manual</em> 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.</p>
<dt><strong>rightside_up</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd><p class="first last">If <code class="docutils literal notranslate"><span class="pre">True</span></code>, label rotations will always be plus
or minus 90 degrees from level. Default is <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<dt><strong>use_clabeltext</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd><p class="first last">If <code class="docutils literal notranslate"><span class="pre">True</span></code>, <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ClabelText</span></code></a> class (instead of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a>) is used to
create labels. <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ClabelText</span></code></a> recalculates rotation angles
of texts during the drawing time, therefore this can be used if
aspect of the axes changes. Default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>labels</dt>
<dd><p class="first last">A list of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a> instances for the labels.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_label_coords">
<code class="descname">get_label_coords</code><span class="sig-paren">(</span><em>self</em>, <em>distances</em>, <em>XX</em>, <em>YY</em>, <em>ysize</em>, <em>lw</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.get_label_coords"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_label_coords" title="Permalink to this definition">¶</a></dt>
<dd><p>Return x, y, and the index of a label location.</p>
<p>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.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_label_width">
<code class="descname">get_label_width</code><span class="sig-paren">(</span><em>self</em>, <em>lev</em>, <em>fmt</em>, <em>fsize</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.get_label_width"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_label_width" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the width of the label in points.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_text">
<code class="descname">get_text</code><span class="sig-paren">(</span><em>self</em>, <em>lev</em>, <em>fmt</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.get_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the text of the label.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.labels">
<code class="descname">labels</code><span class="sig-paren">(</span><em>self</em>, <em>inline</em>, <em>inline_spacing</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.labels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.labels" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.locate_label">
<code class="descname">locate_label</code><span class="sig-paren">(</span><em>self</em>, <em>linecontour</em>, <em>labelwidth</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.locate_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.locate_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Find good place to draw a label (relatively flat part of the contour).</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.pop_label">
<code class="descname">pop_label</code><span class="sig-paren">(</span><em>self</em>, <em>index=-1</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.pop_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.pop_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Defaults to removing last label, but any index can be supplied</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.print_label">
<code class="descname">print_label</code><span class="sig-paren">(</span><em>self</em>, <em>linecontour</em>, <em>labelwidth</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.print_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.print_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>False</em> if contours are too short for a label.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.set_label_props">
<code class="descname">set_label_props</code><span class="sig-paren">(</span><em>self</em>, <em>label</em>, <em>text</em>, <em>color</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.set_label_props"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.set_label_props" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the label properties - color, fontsize, text.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.too_close">
<code class="descname">too_close</code><span class="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em>, <em>lw</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.too_close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.too_close" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if a label is already near this location.</p>
<dl class="class">
<dt id="matplotlib.contour.ContourSet">
<em class="property">class </em><code class="descclassname">matplotlib.contour.</code><code class="descname">ContourSet</code><span class="sig-paren">(</span><em>ax</em>, <em>*args</em>, <em>levels=None</em>, <em>filled=False</em>, <em>linewidths=None</em>, <em>linestyles=None</em>, <em>alpha=None</em>, <em>origin=None</em>, <em>extent=None</em>, <em>cmap=None</em>, <em>colors=None</em>, <em>norm=None</em>, <em>vmin=None</em>, <em>vmax=None</em>, <em>extend='neither'</em>, <em>antialiased=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.cm.ScalarMappable</span></code></a>, <a class="reference internal" href="#matplotlib.contour.ContourLabeler" title="matplotlib.contour.ContourLabeler"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.contour.ContourLabeler</span></code></a></p>
<p>Store a set of contour lines or filled regions.</p>
<p>User-callable method: <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.clabel.html#matplotlib.axes.Axes.clabel" title="matplotlib.axes.Axes.clabel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clabel</span></code></a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a></span></dt>
<dt><strong>levels</strong> <span class="classifier-delimiter">:</span> <span class="classifier">[level0, level1, ..., leveln]</span></dt>
<dd><p class="first last">A list of floating point numbers indicating the contour
levels.</p>
<dt><strong>allsegs</strong> <span class="classifier-delimiter">:</span> <span class="classifier">[level0segs, level1segs, ...]</span></dt>
<dd><p class="first">List of all the polygon segments for all the <em>levels</em>.
For contour lines <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">==</span> <span class="pre">len(levels)</span></code>, and for
filled contour regions <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">=</span> <span class="pre">len(levels)-1</span></code>. The lists
should look like:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0segs</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0</span><span class="p">,</span> <span class="n">polygon1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0</span> <span class="o">=</span> <span class="n">array_like</span> <span class="p">[[</span><span class="n">x0</span><span class="p">,</span><span class="n">y0</span><span class="p">],</span> <span class="p">[</span><span class="n">x1</span><span class="p">,</span><span class="n">y1</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
<dt><strong>allkinds</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><code class="docutils literal notranslate"><span class="pre">None</span></code> or [level0kinds, level1kinds, ...]</span></dt>
<dd><p class="first">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 <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">len(allkinds)</span> <span class="pre">==</span> <span class="pre">len(allsegs)</span></code>. The lists
should look like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0kinds</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">vertexcode0</span><span class="p">,</span> <span class="n">vertexcode1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
<p class="last">If <em>allkinds</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, usually all polygons for a
particular contour level are grouped together so that
<code class="docutils literal notranslate"><span class="pre">level0segs</span> <span class="pre">=</span> <span class="pre">[polygon0]</span></code> and <code class="docutils literal notranslate"><span class="pre">level0kinds</span> <span class="pre">=</span> <span class="pre">[polygon0kinds]</span></code>.</p>
<dt><strong>**kwargs</strong></dt>
<dd><p class="first last">Keyword arguments are as described in the docstring of
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.contour.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><code class="xref py py-obj docutils literal notranslate"><span class="pre">contour</span></code></a>.</p>
<tr class="field-even field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>ax</strong></dt>
<dd><p class="first last">The axes object in which the contours are drawn.</p>
<dt><strong>collections</strong></dt>
<dd><p class="first last">A silent_list of LineCollections or PolyCollections.</p>
<dt><strong>levels</strong></dt>
<dd><p class="first last">Contour levels.</p>
<dt><strong>layers</strong></dt>
<dd><p class="first last">Same as levels for line contours; half-way between
levels for filled contours.  See <code class="xref py py-meth docutils literal notranslate"><span class="pre">_process_colors()</span></code>.</p>
<p>Draw contour lines or filled regions, depending on
whether keyword arg <em>filled</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code> (default) or <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<p>Call signature:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ContourSet</span><span class="p">(</span><span class="n">ax</span><span class="p">,</span> <span class="n">levels</span><span class="p">,</span> <span class="n">allsegs</span><span class="p">,</span> <span class="p">[</span><span class="n">allkinds</span><span class="p">],</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a></span></dt>
<dd><p class="first last">The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> object to draw on.</p>
<dt><strong>levels</strong> <span class="classifier-delimiter">:</span> <span class="classifier">[level0, level1, ..., leveln]</span></dt>
<dd><p class="first last">A list of floating point numbers indicating the contour
levels.</p>
<dt><strong>allsegs</strong> <span class="classifier-delimiter">:</span> <span class="classifier">[level0segs, level1segs, ...]</span></dt>
<dd><p class="first">List of all the polygon segments for all the <em>levels</em>.
For contour lines <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">==</span> <span class="pre">len(levels)</span></code>, and for
filled contour regions <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">=</span> <span class="pre">len(levels)-1</span></code>. The lists
should look like:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0segs</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0</span><span class="p">,</span> <span class="n">polygon1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0</span> <span class="o">=</span> <span class="n">array_like</span> <span class="p">[[</span><span class="n">x0</span><span class="p">,</span><span class="n">y0</span><span class="p">],</span> <span class="p">[</span><span class="n">x1</span><span class="p">,</span><span class="n">y1</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
<dt><strong>allkinds</strong> <span class="classifier-delimiter">:</span> <span class="classifier">[level0kinds, level1kinds, ...], optional</span></dt>
<dd><p class="first">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 <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">len(allkinds)</span> <span class="pre">==</span> <span class="pre">len(allsegs)</span></code>. The lists
should look like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0kinds</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">vertexcode0</span><span class="p">,</span> <span class="n">vertexcode1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
<p class="last">If <em>allkinds</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, usually all polygons for a
particular contour level are grouped together so that
<code class="docutils literal notranslate"><span class="pre">level0segs</span> <span class="pre">=</span> <span class="pre">[polygon0]</span></code> and <code class="docutils literal notranslate"><span class="pre">level0kinds</span> <span class="pre">=</span> <span class="pre">[polygon0kinds]</span></code>.</p>
<dt><strong>**kwargs</strong></dt>
<dd><p class="first last">Keyword arguments are as described in the docstring of
<code class="xref py py-obj docutils literal notranslate"><span class="pre">contour</span></code>.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.changed">
<code class="descname">changed</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.changed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourSet.changed" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal</p>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.find_nearest_contour">
<code class="descname">find_nearest_contour</code><span class="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em>, <em>indices=None</em>, <em>pixel=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.find_nearest_contour"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourSet.find_nearest_contour" title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>Returns a tuple containing the contour, segment, index of
segment, x &amp; y of segment point and distance to minimum point.</p>
<p>Optional keyword arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>indices</em>:</dt>
<dd>Indexes of contour levels to consider when looking for
nearest point.  Defaults to using all levels.</dd>
<dt><em>pixel</em>:</dt>
<dd>If <em>True</em>, measure distance in pixel space, if not, measure
distance in axes space.  Defaults to <em>True</em>.</dd>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.get_alpha">
<code class="descname">get_alpha</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.get_alpha"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourSet.get_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>returns alpha to be applied to all ContourSet artists</p>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.get_transform">
<code class="descname">get_transform</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.get_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourSet.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transform</span></code></a>
instance used by this ContourSet.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.legend_elements">
<code class="descname">legend_elements</code><span class="sig-paren">(</span><em>self</em>, <em>variable_name='x'</em>, <em>str_format=&lt;class 'str'&gt;</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.legend_elements"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourSet.legend_elements" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of artists and labels suitable for passing through
to <code class="xref py py-func docutils literal notranslate"><span class="pre">plt.legend()</span></code> which represent this ContourSet.</p>
<p>The labels have the form &quot;0 &lt; x &lt;= 1&quot; stating the data ranges which
the artists represent.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>variable_name</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">The string used inside the inequality used on the labels.</p>
<dt><strong>str_format</strong> <span class="classifier-delimiter">:</span> <span class="classifier">function: float -&gt; str</span></dt>
<dd><p class="first last">Function used to format the numbers in the labels.</p>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>artists</strong> <span class="classifier-delimiter">:</span> <span class="classifier">List[<a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>]</span></dt>
<dd><p class="first last">A list of the artists.</p>
<dt><strong>labels</strong> <span class="classifier-delimiter">:</span> <span class="classifier">List[str]</span></dt>
<dd><p class="first last">A list of the labels.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.set_alpha">
<code class="descname">set_alpha</code><span class="sig-paren">(</span><em>self</em>, <em>alpha</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.set_alpha"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.ContourSet.set_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the alpha blending value for all ContourSet artists.
<em>alpha</em> must be between 0 (transparent) and 1 (opaque).</p>
<dl class="class">
<dt id="matplotlib.contour.QuadContourSet">
<em class="property">class </em><code class="descclassname">matplotlib.contour.</code><code class="descname">QuadContourSet</code><span class="sig-paren">(</span><em>ax</em>, <em>*args</em>, <em>levels=None</em>, <em>filled=False</em>, <em>linewidths=None</em>, <em>linestyles=None</em>, <em>alpha=None</em>, <em>origin=None</em>, <em>extent=None</em>, <em>cmap=None</em>, <em>colors=None</em>, <em>norm=None</em>, <em>vmin=None</em>, <em>vmax=None</em>, <em>extend='neither'</em>, <em>antialiased=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/contour.html#QuadContourSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.contour.QuadContourSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.contour.ContourSet</span></code></a></p>
<p>Create and store a set of contour lines or filled regions.</p>
<p>User-callable method: <code class="xref py py-obj docutils literal notranslate"><span class="pre">clabel</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>ax</strong></dt>
<dd><p class="first last">The axes object in which the contours are drawn.</p>
<dt><strong>collections</strong></dt>
<dd><p class="first last">A silent_list of LineCollections or PolyCollections.</p>
<dt><strong>levels</strong></dt>
<dd><p class="first last">Contour levels.</p>
<dt><strong>layers</strong></dt>
<dd><p class="first last">Same as levels for line contours; half-way between
levels for filled contours. See <code class="xref py py-meth docutils literal notranslate"><span class="pre">_process_colors()</span></code> method.</p>
<p>Draw contour lines or filled regions, depending on
whether keyword arg <em>filled</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code> (default) or <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<p>Call signature:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ContourSet</span><span class="p">(</span><span class="n">ax</span><span class="p">,</span> <span class="n">levels</span><span class="p">,</span> <span class="n">allsegs</span><span class="p">,</span> <span class="p">[</span><span class="n">allkinds</span><span class="p">],</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a></span></dt>
<dd><p class="first last">The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> object to draw on.</p>
<dt><strong>levels</strong> <span class="classifier-delimiter">:</span> <span class="classifier">[level0, level1, ..., leveln]</span></dt>
<dd><p class="first last">A list of floating point numbers indicating the contour
levels.</p>
<dt><strong>allsegs</strong> <span class="classifier-delimiter">:</span> <span class="classifier">[level0segs, level1segs, ...]</span></dt>
<dd><p class="first">List of all the polygon segments for all the <em>levels</em>.
For contour lines <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">==</span> <span class="pre">len(levels)</span></code>, and for
filled contour regions <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">=</span> <span class="pre">len(levels)-1</span></code>. The lists
should look like:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0segs</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0</span><span class="p">,</span> <span class="n">polygon1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0</span> <span class="o">=</span> <span class="n">array_like</span> <span class="p">[[</span><span class="n">x0</span><span class="p">,</span><span class="n">y0</span><span class="p">],</span> <span class="p">[</span><span class="n">x1</span><span class="p">,</span><span class="n">y1</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
<dt><strong>allkinds</strong> <span class="classifier-delimiter">:</span> <span class="classifier">[level0kinds, level1kinds, ...], optional</span></dt>
<dd><p class="first">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 <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">len(allkinds)</span> <span class="pre">==</span> <span class="pre">len(allsegs)</span></code>. The lists
should look like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0kinds</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">vertexcode0</span><span class="p">,</span> <span class="n">vertexcode1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
<p class="last">If <em>allkinds</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, usually all polygons for a
particular contour level are grouped together so that
<code class="docutils literal notranslate"><span class="pre">level0segs</span> <span class="pre">=</span> <span class="pre">[polygon0]</span></code> and <code class="docutils literal notranslate"><span class="pre">level0kinds</span> <span class="pre">=</span> <span class="pre">[polygon0kinds]</span></code>.</p>
<dt><strong>**kwargs</strong></dt>
<dd><p class="first last">Keyword arguments are as described in the docstring of
<code class="xref py py-obj docutils literal notranslate"><span class="pre">contour</span></code>.</p>
          </div>
        </div>
      </div>
      <div class="clearer"></div>
    <div class="footer">
        &copy; Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
        <br />
      Last updated on Feb 09, 2020.
	Created using
	<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
	Doc version v3.1.3-2-g782f6ef56.
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

contour_api.html

Latest commit

History

contour_api.html

File metadata and controls
