You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
<divid="unreleased-message"> You are reading an old version of the documentation (v2.0.0). For the latest version see <ahref="https://matplotlib.org/stable/api/projections_api.html">https://matplotlib.org/stable/api/projections_api.html</a></div>
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">ProjectionRegistry</code><aclass="headerlink" href="#matplotlib.projections.ProjectionRegistry" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_projection_class</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descname">get_projection_names</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">register</code><spanclass="sig-paren">(</span><em>*projections</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.ProjectionRegistry.register" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">get_projection_class</code><spanclass="sig-paren">(</span><em>projection=None</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">get_projection_names</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.get_projection_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of acceptable projection names.</p>
<codeclass="descclassname">matplotlib.projections.</code><codeclass="descname">process_projection_requirements</code><spanclass="sig-paren">(</span><em>figure</em>, <em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="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,
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.polar.</code><codeclass="descname">InvertedPolarTransform</code><spanclass="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em>xy</em><spanclass="sig-paren">)</span><aclass="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><codeclass="docutils literal"><spanclass="pre">transform(values)</span></code> is always equivalent to
<p>In non-affine transformations, this is generally equivalent to
<codeclass="docutils literal"><spanclass="pre">transform(values)</span></code>. In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <codeclass="xref py py-attr docutils literal"><spanclass="pre">input_dims</span></code>) and
returns a numpy array of shape (N x <codeclass="xref py py-attr docutils literal"><spanclass="pre">output_dims</span></code>).</p>
<p>Alternatively, accepts a numpy array of length <codeclass="xref py py-attr docutils literal"><spanclass="pre">input_dims</span></code>
and returns a numpy array of length <codeclass="xref py py-attr docutils literal"><spanclass="pre">output_dims</span></code>.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.projections.polar.PolarAffine">
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.polar.</code><codeclass="descname">PolarAffine</code><spanclass="sig-paren">(</span><em>scale_transform</em>, <em>limits</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAffine" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_matrix</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.projections.polar.PolarAxes">
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.polar.</code><codeclass="descname">PolarAxes</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">InvertedPolarTransform</code><spanclass="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em>xy</em><spanclass="sig-paren">)</span><aclass="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><codeclass="docutils literal"><spanclass="pre">transform(values)</span></code> is always equivalent to
<emclass="property">class </em><codeclass="descclassname">PolarAxes.</code><codeclass="descname">PolarAffine</code><spanclass="sig-paren">(</span><em>scale_transform</em>, <em>limits</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_matrix</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">PolarAxes.</code><codeclass="descname">PolarTransform</code><spanclass="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em>tr</em><spanclass="sig-paren">)</span><aclass="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><codeclass="docutils literal"><spanclass="pre">transform(values)</span></code> is always equivalent to
<codeclass="descname">transform_path_non_affine</code><spanclass="sig-paren">(</span><em>path</em><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">PolarAxes.</code><codeclass="descname">RadialLocator</code><spanclass="sig-paren">(</span><em>base</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator" title="Permalink to this definition">¶</a></dt>
<p>Ensures that all ticks are strictly positive. For all other
tasks, it delegates to the base
<aclass="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><codeclass="xref py py-class docutils literal"><spanclass="pre">Locator</span></code></a> (which may be different
depending on the scale of the <em>r</em>-axis.</p>
<emclass="property">class </em><codeclass="descclassname">PolarAxes.</code><codeclass="descname">ThetaFormatter</code><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaFormatter" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">can_pan</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">can_zoom</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">format_coord</code><spanclass="sig-paren">(</span><em>theta</em>, <em>r</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">get_data_ratio</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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,
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">get_rlabel_position</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_rlabel_position" title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">get_theta_direction</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<dlclass="docutils">
<dt>-1:</dt>
<dd>Theta increases in the clockwise direction</dd>
<dt>1:</dt>
<dd>Theta increases in the counterclockwise direction</dd>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">get_theta_offset</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">set_rgrids</code><spanclass="sig-paren">(</span><em>radii</em>, <em>labels=None</em>, <em>angle=None</em>, <em>fmt=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal"><spanclass="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 <aclass="reference internal" href="lines_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><codeclass="xref py py-class docutils literal"><spanclass="pre">Line2D</span></code></a> instances and the
<trclass="row-odd"><td><aclass="reference internal" href="text_api.html#matplotlib.text.Text.set_family" title="matplotlib.text.Text.set_family"><codeclass="xref py py-meth docutils literal"><spanclass="pre">family</span></code></a> or fontfamily or fontname or name</td>
<trclass="row-odd"><td><aclass="reference internal" href="text_api.html#matplotlib.text.Text.set_verticalalignment" title="matplotlib.text.Text.set_verticalalignment"><codeclass="xref py py-meth docutils literal"><spanclass="pre">verticalalignment</span></code></a> or ma or va</td>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">set_rlabel_position</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">set_theta_direction</code><spanclass="sig-paren">(</span><em>direction</em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="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>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">set_theta_offset</code><spanclass="sig-paren">(</span><em>offset</em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">set_theta_zero_location</code><spanclass="sig-paren">(</span><em>loc</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_theta_zero_location" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the location of theta’s zero. (Calls set_theta_offset
with the correct value in radians under the hood.)</p>
<p>May be one of “N”, “NW”, “W”, “SW”, “S”, “SE”, “E”, or “NE”.</p>
<codeclass="descclassname">PolarAxes.</code><codeclass="descname">set_thetagrids</code><spanclass="sig-paren">(</span><em>angles</em>, <em>labels=None</em>, <em>frac=None</em>, <em>fmt=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal"><spanclass="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 <codeclass="docutils literal"><spanclass="pre">fmt</span><spanclass="pre">%</span><spanclass="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 <aclass="reference internal" href="lines_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><codeclass="xref py py-class docutils literal"><spanclass="pre">Line2D</span></code></a> instances and the
<trclass="row-odd"><td><aclass="reference internal" href="text_api.html#matplotlib.text.Text.set_family" title="matplotlib.text.Text.set_family"><codeclass="xref py py-meth docutils literal"><spanclass="pre">family</span></code></a> or fontfamily or fontname or name</td>
<trclass="row-odd"><td><aclass="reference internal" href="text_api.html#matplotlib.text.Text.set_verticalalignment" title="matplotlib.text.Text.set_verticalalignment"><codeclass="xref py py-meth docutils literal"><spanclass="pre">verticalalignment</span></code></a> or ma or va</td>
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.polar.</code><codeclass="descname">PolarTransform</code><spanclass="sig-paren">(</span><em>axis=None</em>, <em>use_rmin=True</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.PolarTransform" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em>tr</em><spanclass="sig-paren">)</span><aclass="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><codeclass="docutils literal"><spanclass="pre">transform(values)</span></code> is always equivalent to
<codeclass="descname">transform_path_non_affine</code><spanclass="sig-paren">(</span><em>path</em><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.polar.</code><codeclass="descname">RadialLocator</code><spanclass="sig-paren">(</span><em>base</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.projections.polar.RadialLocator" title="Permalink to this definition">¶</a></dt>
<p>Ensures that all ticks are strictly positive. For all other
tasks, it delegates to the base
<aclass="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><codeclass="xref py py-class docutils literal"><spanclass="pre">Locator</span></code></a> (which may be different
depending on the scale of the <em>r</em>-axis.</p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.projections.polar.</code><codeclass="descname">ThetaFormatter</code><aclass="headerlink" href="#matplotlib.projections.polar.ThetaFormatter" title="Permalink to this definition">¶</a></dt>