matplotlib.github.com/1.5.3/api/projections_api.html at main · matplotlib/matplotlib.github.com

896 lines (825 loc) · 71.6 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>projections &mdash; Matplotlib 1.5.3 documentation</title>
    <link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.5.3',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
    </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 1.5.3 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="top" title="Matplotlib 1.5.3 documentation" href="../index.html" />
    <link rel="up" title="The Matplotlib API" href="index.html" />
    <link rel="next" title="pyplot" href="pyplot_api.html" />
    <link rel="prev" title="patheffects" href="patheffects_api.html" /> 
    <link rel="canonical" href="https://matplotlib.org/stable/api/projections_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 (v1.5.3).  For the latest version see <a href="https://matplotlib.org/stable/api/projections_api.html">https://matplotlib.org/stable/api/projections_api.html</a></div>
    <div class="alert" style="background-color: #FEA46C; padding: 10px 0;
<h2>Matplotlib 2.0.0rc2 is available</h2>
<p><a href="../style_changes.html"
style="font-weight: bold;
color: #11557C;">Install the release candidate now!</a></p>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
    <area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
    <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="pyplot_api.html" title="pyplot"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="patheffects_api.html" title="patheffects"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">home</a>|&nbsp;</li>
        <li><a href="../examples/index.html">examples</a>|&nbsp;</li>
        <li><a href="../gallery.html">gallery</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="http://depsy.org/package/python/matplotlib">
  <img src="http://depsy.org/api/package/pypi/matplotlib/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="#">projections</a><ul>
<li><a class="reference internal" href="#module-matplotlib.projections"><code class="docutils literal"><span class="pre">matplotlib.projections</span></code></a></li>
<li><a class="reference internal" href="#module-matplotlib.projections.polar"><code class="docutils literal"><span class="pre">matplotlib.projections.polar</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="patheffects_api.html" title="previous chapter">patheffects</a></li>
      <li>Next: <a href="pyplot_api.html" title="next chapter">pyplot</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/projections_api.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="projections">
<h1>projections<a class="headerlink" href="#projections" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.projections">
<span id="matplotlib-projections"></span><h2><a class="reference internal" href="#module-matplotlib.projections" title="matplotlib.projections"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.projections</span></code></a><a class="headerlink" href="#module-matplotlib.projections" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="matplotlib.projections.ProjectionRegistry">
<em class="property">class </em><code class="descclassname">matplotlib.projections.</code><code class="descname">ProjectionRegistry</code><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Manages the set of projections available to the system.</p>
<dl class="method">
<dt id="matplotlib.projections.ProjectionRegistry.get_projection_class">
<code class="descname">get_projection_class</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.get_projection_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a projection class from its <em>name</em>.</p>
<dl class="method">
<dt id="matplotlib.projections.ProjectionRegistry.get_projection_names">
<code class="descname">get_projection_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.get_projection_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of the names of all projections currently
registered.</p>
<dl class="method">
<dt id="matplotlib.projections.ProjectionRegistry.register">
<code class="descname">register</code><span class="sig-paren">(</span><em>*projections</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.register" title="Permalink to this definition">¶</a></dt>
<dd><p>Register a new set of projection(s).</p>
<dl class="function">
<dt id="matplotlib.projections.get_projection_class">
<code class="descclassname">matplotlib.projections.</code><code class="descname">get_projection_class</code><span class="sig-paren">(</span><em>projection=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.get_projection_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a projection class from its name.</p>
<p>If <em>projection</em> is None, a standard rectilinear projection is
returned.</p>
<dl class="function">
<dt id="matplotlib.projections.get_projection_names">
<code class="descclassname">matplotlib.projections.</code><code class="descname">get_projection_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.get_projection_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of acceptable projection names.</p>
<dl class="function">
<dt id="matplotlib.projections.process_projection_requirements">
<code class="descclassname">matplotlib.projections.</code><code class="descname">process_projection_requirements</code><span class="sig-paren">(</span><em>figure</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.process_projection_requirements" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle the args/kwargs to for add_axes/add_subplot/gca,
returning:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">axes_proj_class</span><span class="p">,</span> <span class="n">proj_class_kwargs</span><span class="p">,</span> <span class="n">proj_stack_key</span><span class="p">)</span>
</pre></div>
<p>Which can be used for new axes initialization/identification.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><strong>kwargs</strong> is modified in place.</p>
<div class="section" id="module-matplotlib.projections.polar">
<span id="matplotlib-projections-polar"></span><h2><a class="reference internal" href="#module-matplotlib.projections.polar" title="matplotlib.projections.polar"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.projections.polar</span></code></a><a class="headerlink" href="#module-matplotlib.projections.polar" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="matplotlib.projections.polar.InvertedPolarTransform">
<em class="property">class </em><code class="descclassname">matplotlib.projections.polar.</code><code class="descname">InvertedPolarTransform</code><span class="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Transform</span></code></a></p>
<p>The inverse of the polar transform, mapping Cartesian
coordinate space <em>x</em> and <em>y</em> back to <em>theta</em> and <em>r</em>.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.InvertedPolarTransform.inverted">
<code class="descname">inverted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<p>The return value of this method should be treated as
temporary.  An update to <em>self</em> does not cause a corresponding
update to its inverted copy.</p>
<p><code class="docutils literal"><span class="pre">x</span> <span class="pre">===</span> <span class="pre">self.inverted().transform(self.transform(x))</span></code></p>
<dl class="method">
<dt id="matplotlib.projections.polar.InvertedPolarTransform.transform_non_affine">
<code class="descname">transform_non_affine</code><span class="sig-paren">(</span><em>xy</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><code class="docutils literal"><span class="pre">transform(values)</span></code> is always equivalent to
<code class="docutils literal"><span class="pre">transform_affine(transform_non_affine(values))</span></code>.</p>
<p>In non-affine transformations, this is generally equivalent to
<code class="docutils literal"><span class="pre">transform(values)</span></code>.  In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <code class="xref py py-attr docutils literal"><span class="pre">input_dims</span></code>) and
returns a numpy array of shape (N x <code class="xref py py-attr docutils literal"><span class="pre">output_dims</span></code>).</p>
<p>Alternatively, accepts a numpy array of length <code class="xref py py-attr docutils literal"><span class="pre">input_dims</span></code>
and returns a numpy array of length <code class="xref py py-attr docutils literal"><span class="pre">output_dims</span></code>.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAffine">
<em class="property">class </em><code class="descclassname">matplotlib.projections.polar.</code><code class="descname">PolarAffine</code><span class="sig-paren">(</span><em>scale_transform</em>, <em>limits</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAffine" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Affine2DBase</span></code></a></p>
<p>The affine part of the polar projection.  Scales the output so
that maximum radius rests on the edge of the axes circle.</p>
<p><em>limits</em> is the view limit of the data.  The only part of
its bounds that is used is ymax (for the radius maximum).
The theta range is always fixed to (0, 2pi).</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAffine.get_matrix">
<code class="descname">get_matrix</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAffine.get_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the Affine transformation array for the affine part
of this transform.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes">
<em class="property">class </em><code class="descclassname">matplotlib.projections.polar.</code><code class="descname">PolarAxes</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">matplotlib.axes._axes.Axes</span></code></p>
<p>A polar graph projection, where the input dimensions are <em>theta</em>, <em>r</em>.</p>
<p>Theta starts pointing east and goes anti-clockwise.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform">
<em class="property">class </em><code class="descname">InvertedPolarTransform</code><span class="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Transform</span></code></a></p>
<p>The inverse of the polar transform, mapping Cartesian
coordinate space <em>x</em> and <em>y</em> back to <em>theta</em> and <em>r</em>.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.inverted">
<code class="descname">inverted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<p>The return value of this method should be treated as
temporary.  An update to <em>self</em> does not cause a corresponding
update to its inverted copy.</p>
<p><code class="docutils literal"><span class="pre">x</span> <span class="pre">===</span> <span class="pre">self.inverted().transform(self.transform(x))</span></code></p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.transform_non_affine">
<code class="descname">transform_non_affine</code><span class="sig-paren">(</span><em>xy</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><code class="docutils literal"><span class="pre">transform(values)</span></code> is always equivalent to
<code class="docutils literal"><span class="pre">transform_affine(transform_non_affine(values))</span></code>.</p>
<p>In non-affine transformations, this is generally equivalent to
<code class="docutils literal"><span class="pre">transform(values)</span></code>.  In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <code class="xref py py-attr docutils literal"><span class="pre">input_dims</span></code>) and
returns a numpy array of shape (N x <code class="xref py py-attr docutils literal"><span class="pre">output_dims</span></code>).</p>
<p>Alternatively, accepts a numpy array of length <code class="xref py py-attr docutils literal"><span class="pre">input_dims</span></code>
and returns a numpy array of length <code class="xref py py-attr docutils literal"><span class="pre">output_dims</span></code>.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.PolarAffine">
<em class="property">class </em><code class="descclassname">PolarAxes.</code><code class="descname">PolarAffine</code><span class="sig-paren">(</span><em>scale_transform</em>, <em>limits</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Affine2DBase</span></code></a></p>
<p>The affine part of the polar projection.  Scales the output so
that maximum radius rests on the edge of the axes circle.</p>
<p><em>limits</em> is the view limit of the data.  The only part of
its bounds that is used is ymax (for the radius maximum).
The theta range is always fixed to (0, 2pi).</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.PolarAffine.get_matrix">
<code class="descname">get_matrix</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine.get_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the Affine transformation array for the affine part
of this transform.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.PolarTransform">
<em class="property">class </em><code class="descclassname">PolarAxes.</code><code class="descname">PolarTransform</code><span class="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Transform</span></code></a></p>
<p>The base polar transform.  This handles projection <em>theta</em> and
<em>r</em> into Cartesian coordinate space <em>x</em> and <em>y</em>, but does not
perform the ultimate affine transformation into the correct
position.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.PolarTransform.inverted">
<code class="descname">inverted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<p>The return value of this method should be treated as
temporary.  An update to <em>self</em> does not cause a corresponding
update to its inverted copy.</p>
<p><code class="docutils literal"><span class="pre">x</span> <span class="pre">===</span> <span class="pre">self.inverted().transform(self.transform(x))</span></code></p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.PolarTransform.transform_non_affine">
<code class="descname">transform_non_affine</code><span class="sig-paren">(</span><em>tr</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><code class="docutils literal"><span class="pre">transform(values)</span></code> is always equivalent to
<code class="docutils literal"><span class="pre">transform_affine(transform_non_affine(values))</span></code>.</p>
<p>In non-affine transformations, this is generally equivalent to
<code class="docutils literal"><span class="pre">transform(values)</span></code>.  In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <code class="xref py py-attr docutils literal"><span class="pre">input_dims</span></code>) and
returns a numpy array of shape (N x <code class="xref py py-attr docutils literal"><span class="pre">output_dims</span></code>).</p>
<p>Alternatively, accepts a numpy array of length <code class="xref py py-attr docutils literal"><span class="pre">input_dims</span></code>
and returns a numpy array of length <code class="xref py py-attr docutils literal"><span class="pre">output_dims</span></code>.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.PolarTransform.transform_path_non_affine">
<code class="descname">transform_path_non_affine</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.transform_path_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a path, transformed only by the non-affine
part of this transform.</p>
<p><em>path</em>: a <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> instance.</p>
<p><code class="docutils literal"><span class="pre">transform_path(path)</span></code> is equivalent to
<code class="docutils literal"><span class="pre">transform_path_affine(transform_path_non_affine(values))</span></code>.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.RadialLocator">
<em class="property">class </em><code class="descclassname">PolarAxes.</code><code class="descname">RadialLocator</code><span class="sig-paren">(</span><em>base</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Used to locate radius ticks.</p>
<p>Ensures that all ticks are strictly positive.  For all other
tasks, it delegates to the base
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">Locator</span></code></a> (which may be different
depending on the scale of the <em>r</em>-axis.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.ThetaFormatter">
<em class="property">class </em><code class="descclassname">PolarAxes.</code><code class="descname">ThetaFormatter</code><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <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">matplotlib.ticker.Formatter</span></code></a></p>
<p>Used to format the <em>theta</em> tick labels.  Converts the native
unit of radians into degrees and adds a degree symbol.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.can_pan">
<code class="descclassname">PolarAxes.</code><code class="descname">can_pan</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.can_pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if this axes supports the pan/zoom button functionality.</p>
<p>For polar axes, this is slightly misleading. Both panning and
zooming are performed by the same button. Panning is performed
in azimuth while zooming is done along the radial.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.can_zoom">
<code class="descclassname">PolarAxes.</code><code class="descname">can_zoom</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.can_zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if this axes supports the zoom box button functionality.</p>
<p>Polar axes do not support zoom boxes.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.format_coord">
<code class="descclassname">PolarAxes.</code><code class="descname">format_coord</code><span class="sig-paren">(</span><em>theta</em>, <em>r</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.format_coord" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a format string formatting the coordinate using Unicode
characters.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.get_data_ratio">
<code class="descclassname">PolarAxes.</code><code class="descname">get_data_ratio</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_data_ratio" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the aspect ratio of the data itself.  For a polar plot,
this should always be 1.0</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.get_rlabel_position">
<code class="descclassname">PolarAxes.</code><code class="descname">get_rlabel_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rlabel_position" title="Permalink to this definition">¶</a></dt>
<dd><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">Returns:</th><td class="field-body"><p class="first">float</p>
<blockquote class="last">
<div><p>The theta position of the radius labels in degrees.</p>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.get_theta_direction">
<code class="descclassname">PolarAxes.</code><code class="descname">get_theta_direction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_theta_direction" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the direction in which theta increases.</p>
<dl class="docutils">
<dt>-1:</dt>
<dd>Theta increases in the clockwise direction</dd>
<dt>1:</dt>
<dd>Theta increases in the counterclockwise direction</dd>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.get_theta_offset">
<code class="descclassname">PolarAxes.</code><code class="descname">get_theta_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_theta_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the offset for the location of 0 in radians.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_rgrids">
<code class="descclassname">PolarAxes.</code><code class="descname">set_rgrids</code><span class="sig-paren">(</span><em>radii</em>, <em>labels=None</em>, <em>angle=None</em>, <em>fmt=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_rgrids" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the radial locations and labels of the <em>r</em> grids.</p>
<p>The labels will appear at radial distances <em>radii</em> at the
given <em>angle</em> in degrees.</p>
<p><em>labels</em>, if not None, is a <code class="docutils literal"><span class="pre">len(radii)</span></code> list of strings of the
labels to use at each radius.</p>
<p>If <em>labels</em> is None, the built-in formatter will be used.</p>
<p>Return value is a list of tuples (<em>line</em>, <em>label</em>), where
<em>line</em> is <a class="reference internal" href="lines_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal"><span class="pre">Line2D</span></code></a> instances and the
<em>label</em> is <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> instances.</p>
<p>kwargs are optional text properties for the labels:</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="artist_api.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>unknown</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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="artist_api.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>[True | False]</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><code class="xref py py-meth docutils literal"><span class="pre">axes</span></code></a></td>
<td>an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance</td>
<tr class="row-even"><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-odd"><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-even"><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="../devel/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-odd"><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-even"><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="../devel/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="patches_api.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-odd"><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-even"><td><a class="reference internal" href="artist_api.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-odd"><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 fontname or fontfamily or name</td>
<td>[FONTNAME | &#8216;serif&#8217; | &#8216;sans-serif&#8217; | &#8216;cursive&#8217; | &#8216;fantasy&#8217; | &#8216;monospace&#8217; ]</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></code></a> instance</td>
<tr class="row-odd"><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-even"><td><a class="reference internal" href="artist_api.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-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"><span class="pre">horizontalalignment</span></code></a> or ha</td>
<td>[ &#8216;center&#8217; | &#8216;right&#8217; | &#8216;left&#8217; ]</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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>string or anything printable with &#8216;%s&#8217; conversion.</td>
<tr class="row-odd"><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-even"><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></td>
<td>[&#8216;left&#8217; | &#8216;right&#8217; | &#8216;center&#8217; ]</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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>unknown</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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|float|boolean|callable]</td>
<tr class="row-odd"><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-even"><td><a class="reference internal" href="artist_api.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>[True | False | None]</td>
<tr class="row-odd"><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 | &#8216;vertical&#8217; | &#8216;horizontal&#8217; ]</td>
<tr class="row-even"><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>unknown</td>
<tr class="row-odd"><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 | &#8216;xx-small&#8217; | &#8216;x-small&#8217; | &#8216;small&#8217; | &#8216;medium&#8217; | &#8216;large&#8217; | &#8216;x-large&#8217; | &#8216;xx-large&#8217; ]</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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>unknown</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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>unknown</td>
<tr class="row-even"><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 | &#8216;ultra-condensed&#8217; | &#8216;extra-condensed&#8217; | &#8216;condensed&#8217; | &#8216;semi-condensed&#8217; | &#8216;normal&#8217; | &#8216;semi-expanded&#8217; | &#8216;expanded&#8217; | &#8216;extra-expanded&#8217; | &#8216;ultra-expanded&#8217; ]</td>
<tr class="row-odd"><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>[ &#8216;normal&#8217; | &#8216;italic&#8217; | &#8216;oblique&#8217;]</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"><span class="pre">text</span></code></a></td>
<td>string or anything printable with &#8216;%s&#8217; conversion.</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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="../devel/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</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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-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"><span class="pre">usetex</span></code></a></td>
<td>unknown</td>
<tr class="row-even"><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>[ &#8216;normal&#8217; | &#8216;small-caps&#8217; ]</td>
<tr class="row-odd"><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 ma or va</td>
<td>[ &#8216;center&#8217; | &#8216;top&#8217; | &#8216;bottom&#8217; | &#8216;baseline&#8217; ]</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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>[True | False]</td>
<tr class="row-odd"><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 | &#8216;ultralight&#8217; | &#8216;light&#8217; | &#8216;normal&#8217; | &#8216;regular&#8217; | &#8216;book&#8217; | &#8216;medium&#8217; | &#8216;roman&#8217; | &#8216;semibold&#8217; | &#8216;demibold&#8217; | &#8216;demi&#8217; | &#8216;bold&#8217; | &#8216;heavy&#8217; | &#8216;extra bold&#8217; | &#8216;black&#8217; ]</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"><span class="pre">wrap</span></code></a></td>
<td>unknown</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"><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"><span class="pre">y</span></code></a></td>
<td>float</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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>any number</td>
</div></blockquote>
<p>ACCEPTS: sequence of floats</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_rlabel_position">
<code class="descclassname">PolarAxes.</code><code class="descname">set_rlabel_position</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_rlabel_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the theta position of the radius labels.</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"><p class="first"><strong>value</strong> : number</p>
<blockquote class="last">
<div><p>The angular position of the radius labels in degrees.</p>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_theta_direction">
<code class="descclassname">PolarAxes.</code><code class="descname">set_theta_direction</code><span class="sig-paren">(</span><em>direction</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_theta_direction" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the direction in which theta increases.</p>
<dl class="docutils">
<dt>clockwise, -1:</dt>
<dd>Theta increases in the clockwise direction</dd>
<dt>counterclockwise, anticlockwise, 1:</dt>
<dd>Theta increases in the counterclockwise direction</dd>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_theta_offset">
<code class="descclassname">PolarAxes.</code><code class="descname">set_theta_offset</code><span class="sig-paren">(</span><em>offset</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_theta_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the offset for the location of 0 in radians.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_theta_zero_location">
<code class="descclassname">PolarAxes.</code><code class="descname">set_theta_zero_location</code><span class="sig-paren">(</span><em>loc</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_theta_zero_location" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the location of theta&#8217;s zero.  (Calls set_theta_offset
with the correct value in radians under the hood.)</p>
<p>May be one of &#8220;N&#8221;, &#8220;NW&#8221;, &#8220;W&#8221;, &#8220;SW&#8221;, &#8220;S&#8221;, &#8220;SE&#8221;, &#8220;E&#8221;, or &#8220;NE&#8221;.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_thetagrids">
<code class="descclassname">PolarAxes.</code><code class="descname">set_thetagrids</code><span class="sig-paren">(</span><em>angles</em>, <em>labels=None</em>, <em>frac=None</em>, <em>fmt=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_thetagrids" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the angles at which to place the theta grids (these
gridlines are equal along the theta dimension).  <em>angles</em> is in
degrees.</p>
<p><em>labels</em>, if not None, is a <code class="docutils literal"><span class="pre">len(angles)</span></code> list of strings of
the labels to use at each angle.</p>
<p>If <em>labels</em> is None, the labels will be <code class="docutils literal"><span class="pre">fmt</span> <span class="pre">%</span> <span class="pre">angle</span></code></p>
<p><em>frac</em> is the fraction of the polar axes radius at which to
place the label (1 is the edge). e.g., 1.05 is outside the axes
and 0.95 is inside the axes.</p>
<p>Return value is a list of tuples (<em>line</em>, <em>label</em>), where
<em>line</em> is <a class="reference internal" href="lines_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal"><span class="pre">Line2D</span></code></a> instances and the
<em>label</em> is <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> instances.</p>
<p>kwargs are optional text properties for the labels:</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="artist_api.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>unknown</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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="artist_api.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>[True | False]</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><code class="xref py py-meth docutils literal"><span class="pre">axes</span></code></a></td>
<td>an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance</td>
<tr class="row-even"><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-odd"><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-even"><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="../devel/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-odd"><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-even"><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="../devel/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="patches_api.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-odd"><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-even"><td><a class="reference internal" href="artist_api.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-odd"><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 fontname or fontfamily or name</td>
<td>[FONTNAME | &#8216;serif&#8217; | &#8216;sans-serif&#8217; | &#8216;cursive&#8217; | &#8216;fantasy&#8217; | &#8216;monospace&#8217; ]</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></code></a> instance</td>
<tr class="row-odd"><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-even"><td><a class="reference internal" href="artist_api.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-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"><span class="pre">horizontalalignment</span></code></a> or ha</td>
<td>[ &#8216;center&#8217; | &#8216;right&#8217; | &#8216;left&#8217; ]</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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>string or anything printable with &#8216;%s&#8217; conversion.</td>
<tr class="row-odd"><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-even"><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></td>
<td>[&#8216;left&#8217; | &#8216;right&#8217; | &#8216;center&#8217; ]</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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>unknown</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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|float|boolean|callable]</td>
<tr class="row-odd"><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-even"><td><a class="reference internal" href="artist_api.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>[True | False | None]</td>
<tr class="row-odd"><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 | &#8216;vertical&#8217; | &#8216;horizontal&#8217; ]</td>
<tr class="row-even"><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>unknown</td>
<tr class="row-odd"><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 | &#8216;xx-small&#8217; | &#8216;x-small&#8217; | &#8216;small&#8217; | &#8216;medium&#8217; | &#8216;large&#8217; | &#8216;x-large&#8217; | &#8216;xx-large&#8217; ]</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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>unknown</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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>unknown</td>
<tr class="row-even"><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 | &#8216;ultra-condensed&#8217; | &#8216;extra-condensed&#8217; | &#8216;condensed&#8217; | &#8216;semi-condensed&#8217; | &#8216;normal&#8217; | &#8216;semi-expanded&#8217; | &#8216;expanded&#8217; | &#8216;extra-expanded&#8217; | &#8216;ultra-expanded&#8217; ]</td>
<tr class="row-odd"><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>[ &#8216;normal&#8217; | &#8216;italic&#8217; | &#8216;oblique&#8217;]</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"><span class="pre">text</span></code></a></td>
<td>string or anything printable with &#8216;%s&#8217; conversion.</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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="../devel/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</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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-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"><span class="pre">usetex</span></code></a></td>
<td>unknown</td>
<tr class="row-even"><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>[ &#8216;normal&#8217; | &#8216;small-caps&#8217; ]</td>
<tr class="row-odd"><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 ma or va</td>
<td>[ &#8216;center&#8217; | &#8216;top&#8217; | &#8216;bottom&#8217; | &#8216;baseline&#8217; ]</td>
<tr class="row-even"><td><a class="reference internal" href="artist_api.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>[True | False]</td>
<tr class="row-odd"><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 | &#8216;ultralight&#8217; | &#8216;light&#8217; | &#8216;normal&#8217; | &#8216;regular&#8217; | &#8216;book&#8217; | &#8216;medium&#8217; | &#8216;roman&#8217; | &#8216;semibold&#8217; | &#8216;demibold&#8217; | &#8216;demi&#8217; | &#8216;bold&#8217; | &#8216;heavy&#8217; | &#8216;extra bold&#8217; | &#8216;black&#8217; ]</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"><span class="pre">wrap</span></code></a></td>
<td>unknown</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"><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"><span class="pre">y</span></code></a></td>
<td>float</td>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.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>any number</td>
</div></blockquote>
<p>ACCEPTS: sequence of floats</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarTransform">
<em class="property">class </em><code class="descclassname">matplotlib.projections.polar.</code><code class="descname">PolarTransform</code><span class="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Transform</span></code></a></p>
<p>The base polar transform.  This handles projection <em>theta</em> and
<em>r</em> into Cartesian coordinate space <em>x</em> and <em>y</em>, but does not
perform the ultimate affine transformation into the correct
position.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarTransform.inverted">
<code class="descname">inverted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<p>The return value of this method should be treated as
temporary.  An update to <em>self</em> does not cause a corresponding
update to its inverted copy.</p>
<p><code class="docutils literal"><span class="pre">x</span> <span class="pre">===</span> <span class="pre">self.inverted().transform(self.transform(x))</span></code></p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarTransform.transform_non_affine">
<code class="descname">transform_non_affine</code><span class="sig-paren">(</span><em>tr</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><code class="docutils literal"><span class="pre">transform(values)</span></code> is always equivalent to
<code class="docutils literal"><span class="pre">transform_affine(transform_non_affine(values))</span></code>.</p>
<p>In non-affine transformations, this is generally equivalent to
<code class="docutils literal"><span class="pre">transform(values)</span></code>.  In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <code class="xref py py-attr docutils literal"><span class="pre">input_dims</span></code>) and
returns a numpy array of shape (N x <code class="xref py py-attr docutils literal"><span class="pre">output_dims</span></code>).</p>
<p>Alternatively, accepts a numpy array of length <code class="xref py py-attr docutils literal"><span class="pre">input_dims</span></code>
and returns a numpy array of length <code class="xref py py-attr docutils literal"><span class="pre">output_dims</span></code>.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarTransform.transform_path_non_affine">
<code class="descname">transform_path_non_affine</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.PolarTransform.transform_path_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a path, transformed only by the non-affine
part of this transform.</p>
<p><em>path</em>: a <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> instance.</p>
<p><code class="docutils literal"><span class="pre">transform_path(path)</span></code> is equivalent to
<code class="docutils literal"><span class="pre">transform_path_affine(transform_path_non_affine(values))</span></code>.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.RadialLocator">
<em class="property">class </em><code class="descclassname">matplotlib.projections.polar.</code><code class="descname">RadialLocator</code><span class="sig-paren">(</span><em>base</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.projections.polar.RadialLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Used to locate radius ticks.</p>
<p>Ensures that all ticks are strictly positive.  For all other
tasks, it delegates to the base
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">Locator</span></code></a> (which may be different
depending on the scale of the <em>r</em>-axis.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.ThetaFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.projections.polar.</code><code class="descname">ThetaFormatter</code><a class="headerlink" href="#matplotlib.projections.polar.ThetaFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <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">matplotlib.ticker.Formatter</span></code></a></p>
<p>Used to format the <em>theta</em> tick labels.  Converts the native
unit of radians into degrees and adds a degree symbol.</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 - 2014 The matplotlib development team.
      Last updated on Dec 19, 2016.
      Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.4.3.
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

projections_api.html

Latest commit

History

projections_api.html

File metadata and controls
