matplotlib.github.com/2.1.2/api/contour_api.html at main · ACPMAD/matplotlib.github.com

842 lines (765 loc) · 62.1 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>contour &mdash; Matplotlib 2.1.2 documentation</title>
    <link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
    <link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '2.1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
    </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>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Matplotlib 2.1.2 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 2.1.2 documentation" href="../index.html" />
    <link rel="up" title="The Matplotlib API" href="index.html" />
    <link rel="next" title="container" href="container_api.html" />
    <link rel="prev" title="matplotlib.colors.get_named_colors_mapping" href="_as_gen/matplotlib.colors.get_named_colors_mapping.html" /> 
    <link rel="canonical" href="https://matplotlib.org/stable/api/contour_api.html" />
<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.2).  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 2.1.2</span></div>
    <img src="../_static/logo2.png" 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>
    <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="container_api.html" title="container"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="_as_gen/matplotlib.colors.get_named_colors_mapping.html" title="matplotlib.colors.get_named_colors_mapping"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">home</a>|&nbsp;</li>
        <li><a href="../gallery/index.html">examples</a>|&nbsp;</li>
        <li><a href="../tutorials/index.html">tutorials</a>|&nbsp;</li>
        <li><a href="pyplot_summary.html">pyplot</a>|&nbsp;</li>
        <li><a href="../contents.html">docs</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">The Matplotlib API</a> &raquo;</li> 
      </ul>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
  <image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&amp;colorA=E1523D&amp;colorB=007D8A">
<a href="http://depsy.org/package/python/matplotlib">
  <img src="../_static/depsy_badge.svg">
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
  <img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
  <h3><a href="../contents.html">Table Of Contents</a></h3>
<li><a class="reference internal" href="#">contour</a><ul>
<li><a class="reference internal" href="#module-matplotlib.contour"><code class="docutils literal"><span class="pre">matplotlib.contour</span></code></a></li>
<div class="relations">
<h3>Related Topics</h3>
  <li><a href="../contents.html">Documentation overview</a><ul>
  <li><a href="index.html">The Matplotlib API</a><ul>
      <li>Previous: <a href="_as_gen/matplotlib.colors.get_named_colors_mapping.html" title="previous chapter">matplotlib.colors.get_named_colors_mapping</a></li>
      <li>Next: <a href="container_api.html" title="next chapter">container</a></li>
  </ul></li>
  </ul></li>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/api/contour_api.rst.txt"
            rel="nofollow">Show Source</a></li>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
  <div class="section" id="contour">
<h1>contour<a class="headerlink" href="#contour" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.contour">
<span id="matplotlib-contour"></span><h2><a class="reference internal" href="#module-matplotlib.contour" title="matplotlib.contour"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.contour</span></code></a><a class="headerlink" href="#module-matplotlib.contour" title="Permalink to this headline">¶</a></h2>
<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="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"><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-class docutils literal"><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="docutils">
<col width="30%" />
<col width="70%" />
</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"><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"><span class="pre">alpha</span></code></a></td>
<td>float (0.0 transparent through 1.0 opaque)</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"><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"><span class="pre">backgroundcolor</span></code></a></td>
<td>any matplotlib 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"><span class="pre">bbox</span></code></a></td>
<td>FancyBboxPatch prop dict</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"><span class="pre">clip_box</span></code></a></td>
<td>a <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></code></a> instance</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"><span class="pre">clip_on</span></code></a></td>
<td>[True | False]</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"><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-class docutils literal"><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-class docutils literal"><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-class docutils literal"><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"><span class="pre">color</span></code></a></td>
<td>any matplotlib 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"><span class="pre">contains</span></code></a></td>
<td>a callable function</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_family" title="matplotlib.text.Text.set_family"><code class="xref py py-meth docutils literal"><span class="pre">family</span></code></a> or fontfamily or fontname or name</td>
<td>[FONTNAME | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ | ‘monospace’ ]</td>
<tr class="row-odd"><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"><span class="pre">figure</span></code></a></td>
<td>a <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"><span class="pre">Figure</span></code></a> instance</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"><span class="pre">fontproperties</span></code></a> or font_properties</td>
<td>a <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.font_manager.FontProperties</span></code></a> instance</td>
<tr class="row-odd"><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"><span class="pre">gid</span></code></a></td>
<td>an id string</td>
<tr class="row-even"><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"><span class="pre">horizontalalignment</span></code></a> or ha</td>
<td>[ ‘center’ | ‘right’ | ‘left’ ]</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"><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"><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"><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"><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"><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"><span class="pre">picker</span></code></a></td>
<td>[None | bool | float | 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"><span class="pre">position</span></code></a></td>
<td>(x,y)</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"><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"><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"><span class="pre">rotation_mode</span></code></a></td>
<td>[ None | “default” | “anchor” ]</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_size" title="matplotlib.text.Text.set_size"><code class="xref py py-meth docutils literal"><span class="pre">size</span></code></a> or fontsize</td>
<td>[size in points | ‘xx-small’ | ‘x-small’ | ‘small’ | ‘medium’ | ‘large’ | ‘x-large’ | ‘xx-large’ ]</td>
<tr class="row-odd"><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"><span class="pre">sketch_params</span></code></a></td>
<td>(scale: float, length: float, randomness: float)</td>
<tr class="row-even"><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"><span class="pre">snap</span></code></a></td>
<td>bool or None</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_stretch" title="matplotlib.text.Text.set_stretch"><code class="xref py py-meth docutils literal"><span class="pre">stretch</span></code></a> or fontstretch</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-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_style" title="matplotlib.text.Text.set_style"><code class="xref py py-meth docutils literal"><span class="pre">style</span></code></a> or fontstyle</td>
<td>[ ‘normal’ | ‘italic’ | ‘oblique’]</td>
<tr class="row-odd"><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"><span class="pre">text</span></code></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
<tr class="row-even"><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"><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"><span class="pre">Transform</span></code></a></td>
<tr class="row-odd"><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"><span class="pre">url</span></code></a></td>
<td>a url string</td>
<tr class="row-even"><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"><span class="pre">usetex</span></code></a></td>
<td>bool or None</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_variant" title="matplotlib.text.Text.set_variant"><code class="xref py py-meth docutils literal"><span class="pre">variant</span></code></a> or fontvariant</td>
<td>[ ‘normal’ | ‘small-caps’ ]</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"><span class="pre">verticalalignment</span></code></a> or va</td>
<td>[ ‘center’ | ‘top’ | ‘bottom’ | ‘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"><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_weight" title="matplotlib.text.Text.set_weight"><code class="xref py py-meth docutils literal"><span class="pre">weight</span></code></a> or fontweight</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-odd"><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"><span class="pre">wrap</span></code></a></td>
<td>bool</td>
<tr class="row-even"><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"><span class="pre">x</span></code></a></td>
<td>float</td>
<tr class="row-odd"><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"><span class="pre">y</span></code></a></td>
<td>float</td>
<tr class="row-even"><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"><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><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ClabelText.get_rotation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<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="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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Mixin to provide labelling capability to ContourSet</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.add_label">
<code class="descname">add_label</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>rotation</em>, <em>lev</em>, <em>cvalue</em><span class="sig-paren">)</span><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"><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>x</em>, <em>y</em>, <em>rotation</em>, <em>lev</em>, <em>cvalue</em><span class="sig-paren">)</span><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"><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>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="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>
<dl class="docutils">
<dt><em>inline</em>:</dt>
<dd>controls whether the underlying contour is removed or
not. Default is <em>True</em>.</dd>
<dt><em>inline_spacing</em>:</dt>
<dd>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.</dd>
<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>slc</em>, <em>ind</em>, <em>lw</em>, <em>lc=None</em>, <em>spacing=5</em><span class="sig-paren">)</span><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 calling mlab.path_length
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="method">
<dt id="matplotlib.contour.ContourLabeler.clabel">
<code class="descname">clabel</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><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"><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="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"><span class="pre">ContourSet</span></code></a> object returned by
contour.</p>
<div class="highlight-default"><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="n">v</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
<p>only labels contours listed in <em>v</em>.</p>
<p>Optional keyword arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>fontsize</em>:</dt>
<dd>size in points or relative size e.g., ‘smaller’, ‘x-large’</dd>
<dt><em>colors</em>:</dt>
<dd><ul class="first 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><em>inline</em>:</dt>
<dd>controls whether the underlying contour is removed or
not. Default is <em>True</em>.</dd>
<dt><em>inline_spacing</em>:</dt>
<dd>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.</dd>
<dt><em>fmt</em>:</dt>
<dd>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 <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">Formatter</span></code></a> instance, that
returns a string when called with a numeric contour level.</dd>
<dt><em>manual</em>:</dt>
<dd><p class="first">if <em>True</em>, 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 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><em>rightside_up</em>:</dt>
<dd>if <em>True</em> (default), label rotations will always be plus
or minus 90 degrees from level.</dd>
<dt><em>use_clabeltext</em>:</dt>
<dd>if <em>True</em> (default is False), ClabelText class (instead of
matplotlib.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.</dd>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_label_coords">
<code class="descname">get_label_coords</code><span class="sig-paren">(</span><em>distances</em>, <em>XX</em>, <em>YY</em>, <em>ysize</em>, <em>lw</em><span class="sig-paren">)</span><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>lev</em>, <em>fmt</em>, <em>fsize</em><span class="sig-paren">)</span><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_real_label_width">
<code class="descname">get_real_label_width</code><span class="sig-paren">(</span><em>lev</em>, <em>fmt</em>, <em>fsize</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_real_label_width" title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<p>This method is not being used, and may be modified or removed.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_text">
<code class="descname">get_text</code><span class="sig-paren">(</span><em>lev</em>, <em>fmt</em><span class="sig-paren">)</span><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>inline</em>, <em>inline_spacing</em><span class="sig-paren">)</span><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>linecontour</em>, <em>labelwidth</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.locate_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Find a good place to plot 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>index=-1</em><span class="sig-paren">)</span><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>linecontour</em>, <em>labelwidth</em><span class="sig-paren">)</span><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>label</em>, <em>text</em>, <em>color</em><span class="sig-paren">)</span><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>x</em>, <em>y</em>, <em>lw</em><span class="sig-paren">)</span><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>**kwargs</em><span class="sig-paren">)</span><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"><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"><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: clabel</p>
<p class="rubric">Attributes</p>
<table border="1" class="docutils">
<col width="13%" />
<col width="87%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><strong>ax:</strong></td>
<td>The axes object in which the contours are drawn.</td>
<tr class="row-even"><td><strong>collections:</strong></td>
<td>A silent_list of LineCollections or PolyCollections.</td>
<tr class="row-odd"><td><strong>levels:</strong></td>
<td>Contour levels.</td>
<tr class="row-even"><td><strong>layers:</strong></td>
<td>Same as levels for line contours; half-way between levels for filled contours.  See <code class="xref py py-meth docutils literal"><span class="pre">_process_colors()</span></code>.</td>
<p>Draw contour lines or filled regions, depending on
whether keyword arg <em>filled</em> is <code class="docutils literal"><span class="pre">False</span></code> (default) or <code class="docutils literal"><span class="pre">True</span></code>.</p>
<p>The first three arguments must be:</p>
<blockquote>
<div><p><em>ax</em>: axes object.</p>
<dl class="docutils">
<dt><em>levels</em>: [level0, level1, …, leveln]</dt>
<dd>A list of floating point numbers indicating the contour
levels.</dd>
<dt><em>allsegs</em>: [level0segs, level1segs, …]</dt>
<dd><p class="first">List of all the polygon segments for all the <em>levels</em>.
For contour lines <code class="docutils literal"><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"><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"><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><em>allkinds</em>: <em>None</em> or [level0kinds, level1kinds, …]</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"><span class="pre">None</span></code>, <code class="docutils literal"><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"><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"><span class="pre">None</span></code>, usually all polygons for a
particular contour level are grouped together so that
<code class="docutils literal"><span class="pre">level0segs</span> <span class="pre">=</span> <span class="pre">[polygon0]</span></code> and <code class="docutils literal"><span class="pre">level0kinds</span> <span class="pre">=</span> <span class="pre">[polygon0kinds]</span></code>.</p>
</div></blockquote>
<p>Keyword arguments are as described in
<a class="reference internal" href="#matplotlib.contour.QuadContourSet.contour_doc" title="matplotlib.contour.QuadContourSet.contour_doc"><code class="xref py py-attr docutils literal"><span class="pre">matplotlib.contour.QuadContourSet.contour_doc</span></code></a>.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.changed">
<code class="descname">changed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.changed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.find_nearest_contour">
<code class="descname">find_nearest_contour</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>indices=None</em>, <em>pixel=True</em><span class="sig-paren">)</span><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><span class="sig-paren">)</span><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><span class="sig-paren">)</span><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"><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>variable_name='x'</em>, <em>str_format=&lt;class 'str'&gt;</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.legend_elements" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of artist and labels suitable for passing through
to <code class="xref py py-func docutils literal"><span class="pre">plt.legend()</span></code> which represent this ContourSet.</p>
<p>Args:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>variable_name</em>: the string used inside the inequality used</dt>
<dd>on the labels</dd>
<p><em>str_format</em>: function used to format the numbers in the labels</p>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.set_alpha">
<code class="descname">set_alpha</code><span class="sig-paren">(</span><em>alpha</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.set_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>sets alpha for all ContourSet artists</p>
<dl class="attribute">
<dt id="matplotlib.contour.ContourSet.vmax">
<code class="descname">vmax</code><a class="headerlink" href="#matplotlib.contour.ContourSet.vmax" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.contour.ContourSet.vmin">
<code class="descname">vmin</code><a class="headerlink" href="#matplotlib.contour.ContourSet.vmin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<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>**kwargs</em><span class="sig-paren">)</span><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"><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-meth docutils literal"><span class="pre">clabel()</span></code></p>
<p class="rubric">Attributes</p>
<table border="1" class="docutils">
<col width="12%" />
<col width="88%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><strong>ax:</strong></td>
<td>The axes object in which the contours are drawn.</td>
<tr class="row-even"><td><strong>collections:</strong></td>
<td>A silent_list of LineCollections or PolyCollections.</td>
<tr class="row-odd"><td><strong>levels:</strong></td>
<td>Contour levels.</td>
<tr class="row-even"><td><strong>layers:</strong></td>
<td>Same as levels for line contours; half-way between levels for filled contours. See <code class="xref py py-meth docutils literal"><span class="pre">_process_colors()</span></code> method.</td>
<p>Draw contour lines or filled regions, depending on
whether keyword arg <em>filled</em> is <code class="docutils literal"><span class="pre">False</span></code> (default) or <code class="docutils literal"><span class="pre">True</span></code>.</p>
<p>The first three arguments must be:</p>
<blockquote>
<div><p><em>ax</em>: axes object.</p>
<dl class="docutils">
<dt><em>levels</em>: [level0, level1, …, leveln]</dt>
<dd>A list of floating point numbers indicating the contour
levels.</dd>
<dt><em>allsegs</em>: [level0segs, level1segs, …]</dt>
<dd><p class="first">List of all the polygon segments for all the <em>levels</em>.
For contour lines <code class="docutils literal"><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"><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"><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><em>allkinds</em>: <em>None</em> or [level0kinds, level1kinds, …]</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"><span class="pre">None</span></code>, <code class="docutils literal"><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"><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"><span class="pre">None</span></code>, usually all polygons for a
particular contour level are grouped together so that
<code class="docutils literal"><span class="pre">level0segs</span> <span class="pre">=</span> <span class="pre">[polygon0]</span></code> and <code class="docutils literal"><span class="pre">level0kinds</span> <span class="pre">=</span> <span class="pre">[polygon0kinds]</span></code>.</p>
</div></blockquote>
<p>Keyword arguments are as described in
<a class="reference internal" href="#matplotlib.contour.QuadContourSet.contour_doc" title="matplotlib.contour.QuadContourSet.contour_doc"><code class="xref py py-attr docutils literal"><span class="pre">matplotlib.contour.QuadContourSet.contour_doc</span></code></a>.</p>
<dl class="attribute">
<dt id="matplotlib.contour.QuadContourSet.contour_doc">
<code class="descname">contour_doc</code><em class="property"> = &quot;\n        Plot contours.\n\n        :func:`~matplotlib.pyplot.contour` and\n        :func:`~matplotlib.pyplot.contourf` draw contour lines and\n        filled contours, respectively.  Except as noted, function\n        signatures and return values are the same for both versions.\n\n        :func:`~matplotlib.pyplot.contourf` differs from the MATLAB\n        version in that it does not draw the polygon edges.\n        To draw edges, add line contours with\n        calls to :func:`~matplotlib.pyplot.contour`.\n\n\n        Call signatures::\n\n          contour(Z)\n\n        make a contour plot of an array *Z*. The level values are chosen\n        automatically.\n\n        ::\n\n          contour(X,Y,Z)\n\n        *X*, *Y* specify the (x, y) coordinates of the surface\n\n        ::\n\n          contour(Z,N)\n          contour(X,Y,Z,N)\n\n        contour up to *N* automatically-chosen levels.\n\n        ::\n\n          contour(Z,V)\n          contour(X,Y,Z,V)\n\n        draw contour lines at the values specified in sequence *V*,\n        which must be in increasing order.\n\n        ::\n\n          contourf(..., V)\n\n        fill the ``len(V)-1`` regions between the values in *V*,\n        which must be in increasing order.\n\n        ::\n\n          contour(Z, **kwargs)\n\n        Use keyword args to control colors, linewidth, origin, cmap ... see\n        below for more details.\n\n        *X* and *Y* must both be 2-D with the same shape as *Z*, or they\n        must both be 1-D such that ``len(X)`` is the number of columns in\n        *Z* and ``len(Y)`` is the number of rows in *Z*.\n\n        ``C = contour(...)`` returns a\n        :class:`~matplotlib.contour.QuadContourSet` object.\n\n        Optional keyword arguments:\n\n          *corner_mask*: [ *True* | *False* | 'legacy' ]\n            Enable/disable corner masking, which only has an effect if *Z* is\n            a masked array.  If *False*, any quad touching a masked point is\n            masked out.  If *True*, only the triangular corners of quads\n            nearest those points are always masked out, other triangular\n            corners comprising three unmasked points are contoured as usual.\n            If 'legacy', the old contouring algorithm is used, which is\n            equivalent to *False* and is deprecated, only remaining whilst the\n            new algorithm is tested fully.\n\n            If not specified, the default is taken from\n            rcParams['contour.corner_mask'], which is True unless it has\n            been modified.\n\n          *colors*: [ *None* | string | (mpl_colors) ]\n            If *None*, the colormap specified by cmap will be used.\n\n            If a string, like 'r' or 'red', all levels will be plotted in this\n            color.\n\n            If a tuple of matplotlib color args (string, float, rgb, etc),\n            different levels will be plotted in different colors in the order\n            specified.\n\n          *alpha*: float\n            The alpha blending value\n\n          *cmap*: [ *None* | Colormap ]\n            A cm :class:`~matplotlib.colors.Colormap` instance or\n            *None*. If *cmap* is *None* and *colors* is *None*, a\n            default Colormap is used.\n\n          *norm*: [ *None* | Normalize ]\n            A :class:`matplotlib.colors.Normalize` instance for\n            scaling data values to colors. If *norm* is *None* and\n            *colors* is *None*, the default linear scaling is used.\n\n          *vmin*, *vmax*: [ *None* | scalar ]\n            If not *None*, either or both of these values will be\n            supplied to the :class:`matplotlib.colors.Normalize`\n            instance, overriding the default color scaling based on\n            *levels*.\n\n          *levels*: [level0, level1, ..., leveln]\n            A list of floating point numbers indicating the level\n            curves to draw, in increasing order; e.g., to draw just\n            the zero contour pass ``levels=[0]``\n\n          *origin*: [ *None* | 'upper' | 'lower' | 'image' ]\n            If *None*, the first value of *Z* will correspond to the\n            lower left corner, location (0,0). If 'image', the rc\n            value for ``image.origin`` will be used.\n\n            This keyword is not active if *X* and *Y* are specified in\n            the call to contour.\n\n          *extent*: [ *None* | (x0,x1,y0,y1) ]\n\n            If *origin* is not *None*, then *extent* is interpreted as\n            in :func:`matplotlib.pyplot.imshow`: it gives the outer\n            pixel boundaries. In this case, the position of Z[0,0]\n            is the center of the pixel, not a corner. If *origin* is\n            *None*, then (*x0*, *y0*) is the position of Z[0,0], and\n            (*x1*, *y1*) is the position of Z[-1,-1].\n\n            This keyword is not active if *X* and *Y* are specified in\n            the call to contour.\n\n          *locator*: [ *None* | ticker.Locator subclass ]\n            If *locator* is *None*, the default\n            :class:`~matplotlib.ticker.MaxNLocator` is used. The\n            locator is used to determine the contour levels if they\n            are not given explicitly via the *V* argument.\n\n          *extend*: [ 'neither' | 'both' | 'min' | 'max' ]\n            Unless this is 'neither', contour levels are automatically\n            added to one or both ends of the range so that all data\n            are included. These added ranges are then mapped to the\n            special colormap values which default to the ends of the\n            colormap range, but can be set via\n            :meth:`matplotlib.colors.Colormap.set_under` and\n            :meth:`matplotlib.colors.Colormap.set_over` methods.\n\n          *xunits*, *yunits*: [ *None* | registered units ]\n            Override axis units by specifying an instance of a\n            :class:`matplotlib.units.ConversionInterface`.\n\n          *antialiased*: [ *True* | *False* ]\n            enable antialiasing, overriding the defaults.  For\n            filled contours, the default is *True*.  For line contours,\n            it is taken from rcParams['lines.antialiased'].\n\n          *nchunk*: [ 0 | integer ]\n            If 0, no subdivision of the domain.  Specify a positive integer to\n            divide the domain into subdomains of *nchunk* by *nchunk* quads.\n            Chunking reduces the maximum length of polygons generated by the\n            contouring algorithm which reduces the rendering workload passed\n            on to the backend and also requires slightly less RAM.  It can\n            however introduce rendering artifacts at chunk boundaries depending\n            on the backend, the *antialiased* flag and value of *alpha*.\n\n        contour-only keyword arguments:\n\n          *linewidths*: [ *None* | number | tuple of numbers ]\n            If *linewidths* is *None*, the default width in\n            ``lines.linewidth`` in ``matplotlibrc`` is used.\n\n            If a number, all levels will be plotted with this linewidth.\n\n            If a tuple, different levels will be plotted with different\n            linewidths in the order specified.\n\n          *linestyles*: [ *None* | 'solid' | 'dashed' | 'dashdot' | 'dotted' ]\n            If *linestyles* is *None*, the default is 'solid' unless\n            the lines are monochrome.  In that case, negative\n            contours will take their linestyle from the ``matplotlibrc``\n            ``contour.negative_linestyle`` setting.\n\n            *linestyles* can also be an iterable of the above strings\n            specifying a set of linestyles to be used. If this\n            iterable is shorter than the number of contour levels\n            it will be repeated as necessary.\n\n        contourf-only keyword arguments:\n\n          *hatches*:\n            A list of cross hatch patterns to use on the filled areas.\n            If None, no hatching will be added to the contour.\n            Hatching is supported in the PostScript, PDF, SVG and Agg\n            backends only.\n\n\n        Note: contourf fills intervals that are closed at the top; that\n        is, for boundaries *z1* and *z2*, the filled region is::\n\n            z1 &lt; z &lt;= z2\n\n        There is one exception: if the lowest boundary coincides with\n        the minimum value of the *z* array, then that minimum value\n        will be included in the lowest interval.\n        &quot;</em><a class="headerlink" href="#matplotlib.contour.QuadContourSet.contour_doc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
          </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 - 2017 The Matplotlib development team.
      Last updated on Feb 08, 2018.
      Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  ga('create', 'UA-55954603-1', 'auto');
  ga('send', 'pageview');
  <!--Flipcause Integration v3.0// Flipcause Integration Instructions:
Install the following code block once in the website Header (after <head> tag) -->
.fc-black_overlay{
display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;
background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;
.fc-white_content {
opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;
position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;
.fc-main-box{
opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;
.fc-widget_close{
opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);
position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;
.floating_button{
display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;
position:fixed; z-index:999999; overflow: auto;
@keyframes backfadesin {
   from { opacity:0; }
   to {opacity:.5;}
@-moz-keyframes backfadesin {
    from { opacity:0; }
    to {opacity:.5;}
@-webkit-keyframes backfadesin {
    from { opacity:0; }
    to {opacity:.5;}
@-o-keyframes backfadesin {
    from { opacity:0; }
    to {opacity:.5;}
@-ms-keyframes backfadesin {
    from { opacity:0; }
    to {opacity:.5;}
@keyframes fadesin {
   0%{ opacity:0; }
   50%{ opacity:0; }
   75% {opacity: 0; transform: translateY(20px);}
   100% {opacity: 1; transform: translateY(0);}
@-moz-keyframes fadesin {
   0%{ opacity:0; }
   50%{ opacity:0; }
   75% {opacity: 0; -moz-transform: translateY(20px);}
   100% {opacity: 1; -moz-transform: translateY(0);}
@-webkit-keyframes fadesin {
   0%{ opacity:0; }
   50%{ opacity:0; }
   75% {opacity: 0; -webkit-transform: translateY(20px);}
   100% {opacity: 1; -webkit-transform: translateY(0);}
@-o-keyframes fadesin {
   0%{ opacity:0; }
   50%{ opacity:0; }
   75% {opacity: 0; -o-transform: translateY(20px);}
   100% {opacity: 1; -o-transform: translateY(0);}
@-ms-keyframes fadesin {
   0%{ opacity:0; }
   50%{ opacity:0; }
   75% {opacity: 0; -ms-transform: translateY(20px);}
   100% {opacity: 1; -ms-transform: translateY(0);}
<div id="fc-fade" class="fc-black_overlay" onclick="close_window()"></div>
<div id="fc-light" class="fc-white_content">
<div id="fc-main" class="fc-main-box">
<div id="fc-close" class="fc-widget_close" onclick="close_window()">
</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;
border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>
<!--END Flipcause Main Integration Code-->
FilesExpand file tree

contour_api.html

Latest commit

History

contour_api.html

File metadata and controls
