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 (v3.2.2). For the latest version see <ahref="https://matplotlib.org/stable/api/scale_api.html">https://matplotlib.org/stable/api/scale_api.html</a></div>
<spanid="matplotlib-scale"></span><h1><codeclass="docutils literal notranslate"><spanclass="pre">matplotlib.scale</span></code><aclass="headerlink" href="#module-matplotlib.scale" title="Permalink to this headline">¶</a></h1>
<p>Scales define the distribution of data values on an axis, e.g. a log scaling.</p>
<p>They are attached to an <aclass="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Axis</span></code></a> and hold a <aclass="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Transform</span></code></a>, which is
responsible for the actual data transformation.</p>
<p>See also <aclass="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xscale.html#matplotlib.axes.Axes.set_xscale" title="matplotlib.axes.Axes.set_xscale"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">axes.Axes.set_xscale</span></code></a> and the scales examples in the documentation.</p>
<dlclass="py class">
<dtid="matplotlib.scale.FuncScale">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">FuncScale</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em>, <em><spanclass="n">functions</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#FuncScale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.FuncScale" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>axis</strong><spanclass="classifier"><aclass="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Axis</span></code></a></span></dt><dd><p>The axis for the scale.</p>
</dd>
<dt><strong>functions</strong><spanclass="classifier">(callable, callable)</span></dt><dd><p>two-tuple of the forward and inverse functions for the scale.
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#FuncScale.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.FuncScale.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="#matplotlib.scale.FuncTransform" title="matplotlib.scale.FuncTransform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">FuncTransform</span></code></a> associated with this scale.</p>
</dd></dl>
<dlclass="py attribute">
<dtid="matplotlib.scale.FuncScale.name">
<codeclass="descname">name</code><emclass="property"> = 'function'</em><aclass="headerlink" href="#matplotlib.scale.FuncScale.name" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_default_locators_and_formatters</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">axis</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#FuncScale.set_default_locators_and_formatters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.FuncScale.set_default_locators_and_formatters" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locators and formatters of <em>axis</em> to instances suitable for
this scale.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.FuncScaleLog">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">FuncScaleLog</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em>, <em><spanclass="n">functions</span></em>, <em><spanclass="n">base</span><spanclass="o">=</span><spanclass="default_value">10</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#FuncScaleLog"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.FuncScaleLog" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>axis</strong><spanclass="classifier"><aclass="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">matplotlib.axis.Axis</span></code></a></span></dt><dd><p>The axis for the scale.</p>
</dd>
<dt><strong>functions</strong><spanclass="classifier">(callable, callable)</span></dt><dd><p>two-tuple of the forward and inverse functions for the scale.
<dt><strong>base</strong><spanclass="classifier">float</span></dt><dd><p>logarithmic base of the scale (default = 10)</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dlclass="py method">
<dtid="matplotlib.scale.FuncScaleLog.base">
<emclass="property">property </em><codeclass="descname">base</code><aclass="headerlink" href="#matplotlib.scale.FuncScaleLog.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#FuncScaleLog.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.FuncScaleLog.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Transform</span></code></a> associated with this scale.</p>
</dd></dl>
<dlclass="py attribute">
<dtid="matplotlib.scale.FuncScaleLog.name">
<codeclass="descname">name</code><emclass="property"> = 'functionlog'</em><aclass="headerlink" href="#matplotlib.scale.FuncScaleLog.name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.FuncTransform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">FuncTransform</code><spanclass="sig-paren">(</span><em><spanclass="n">forward</span></em>, <em><spanclass="n">inverse</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#FuncTransform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.FuncTransform" title="Permalink to this definition">¶</a></dt>
<dt><strong>inverse</strong><spanclass="classifier">callable</span></dt><dd><p>The inverse of the forward function. Signature as <codeclass="docutils literal notranslate"><spanclass="pre">forward</span></code>.</p>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.FuncTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.FuncTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.scale.FuncTransform.inverted">
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#FuncTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.FuncTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<codeclass="descname">is_separable</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.FuncTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.FuncTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">values</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#FuncTransform.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.FuncTransform.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 notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>values</strong><spanclass="classifier">array</span></dt><dd><p>The output values as NumPy array of length <aclass="reference internal" href="#matplotlib.scale.FuncTransform.input_dims" title="matplotlib.scale.FuncTransform.input_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">input_dims</span></code></a> or
shape (N x <aclass="reference internal" href="#matplotlib.scale.FuncTransform.output_dims" title="matplotlib.scale.FuncTransform.output_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">output_dims</span></code></a>), depending on the input.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.InvertedLog10Transform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">InvertedLog10Transform</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLog10Transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLog10Transform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">base</code><emclass="property"> = 10.0</em><aclass="headerlink" href="#matplotlib.scale.InvertedLog10Transform.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.InvertedLog10Transform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLog10Transform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLog10Transform.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>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.InvertedLog2Transform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">InvertedLog2Transform</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLog2Transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLog2Transform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">base</code><emclass="property"> = 2.0</em><aclass="headerlink" href="#matplotlib.scale.InvertedLog2Transform.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.InvertedLog2Transform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLog2Transform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLog2Transform.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>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.InvertedLogTransform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">InvertedLogTransform</code><spanclass="sig-paren">(</span><em><spanclass="n">base</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLogTransform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLogTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<codeclass="descname">is_separable</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLogTransform.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransform.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 notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">InvertedLogTransformBase</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLogTransformBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransformBase" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransformBase.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">is_separable</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransformBase.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransformBase.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedLogTransformBase.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedLogTransformBase.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 notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">InvertedNaturalLogTransform</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedNaturalLogTransform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedNaturalLogTransform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">base</code><emclass="property"> = 2.718281828459045</em><aclass="headerlink" href="#matplotlib.scale.InvertedNaturalLogTransform.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.InvertedNaturalLogTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedNaturalLogTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedNaturalLogTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.InvertedSymmetricalLogTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.InvertedSymmetricalLogTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedSymmetricalLogTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedSymmetricalLogTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<codeclass="descname">is_separable</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.InvertedSymmetricalLogTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.InvertedSymmetricalLogTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#InvertedSymmetricalLogTransform.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.InvertedSymmetricalLogTransform.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 notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>values</strong><spanclass="classifier">array</span></dt><dd><p>The output values as NumPy array of length <aclass="reference internal" href="#matplotlib.scale.InvertedSymmetricalLogTransform.input_dims" title="matplotlib.scale.InvertedSymmetricalLogTransform.input_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">input_dims</span></code></a> or
shape (N x <aclass="reference internal" href="#matplotlib.scale.InvertedSymmetricalLogTransform.output_dims" title="matplotlib.scale.InvertedSymmetricalLogTransform.output_dims"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">output_dims</span></code></a>), depending on the input.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.LinearScale">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">LinearScale</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em>, <em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LinearScale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LinearScale" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LinearScale.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LinearScale.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the transform for linear scaling, which is just the
<codeclass="descname">name</code><emclass="property"> = 'linear'</em><aclass="headerlink" href="#matplotlib.scale.LinearScale.name" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_default_locators_and_formatters</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">axis</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LinearScale.set_default_locators_and_formatters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LinearScale.set_default_locators_and_formatters" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locators and formatters of <em>axis</em> to instances suitable for
this scale.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.Log10Transform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">Log10Transform</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#Log10Transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.Log10Transform" title="Permalink to this definition">¶</a></dt>
<p><spanclass="versionmodified deprecated">Deprecated since version 3.1: </span></p>
</div>
<dlclass="py attribute">
<dtid="matplotlib.scale.Log10Transform.base">
<codeclass="descname">base</code><emclass="property"> = 10.0</em><aclass="headerlink" href="#matplotlib.scale.Log10Transform.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.Log10Transform.has_inverse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.scale.Log10Transform.inverted">
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#Log10Transform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.Log10Transform.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>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.Log2Transform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">Log2Transform</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#Log2Transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.Log2Transform" title="Permalink to this definition">¶</a></dt>
<p><spanclass="versionmodified deprecated">Deprecated since version 3.1: </span></p>
</div>
<dlclass="py attribute">
<dtid="matplotlib.scale.Log2Transform.base">
<codeclass="descname">base</code><emclass="property"> = 2.0</em><aclass="headerlink" href="#matplotlib.scale.Log2Transform.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.Log2Transform.has_inverse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.scale.Log2Transform.inverted">
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#Log2Transform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.Log2Transform.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>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.LogScale">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">LogScale</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em>, <em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogScale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogScale" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>axis</strong><spanclass="classifier"><aclass="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Axis</span></code></a></span></dt><dd><p>The axis for the scale.</p>
</dd>
<dt><strong>basex, basey</strong><spanclass="classifier">float, default: 10</span></dt><dd><p>The base of the logarithm.</p>
</dd>
<dt><strong>nonposx, nonposy</strong><spanclass="classifier">{'clip', 'mask'}, default: 'clip'</span></dt><dd><p>Determines the behavior for non-positive values. They can either
be masked as invalid, or clipped to a very small positive number.</p>
</dd>
<dt><strong>subsx, subsy</strong><spanclass="classifier">sequence of int, default: None</span></dt><dd><p>Where to place the subticks between each major tick.
For example, in a log10 scale: <codeclass="docutils literal notranslate"><spanclass="pre">[2,</span><spanclass="pre">3,</span><spanclass="pre">4,</span><spanclass="pre">5,</span><spanclass="pre">6,</span><spanclass="pre">7,</span><spanclass="pre">8,</span><spanclass="pre">9]</span></code>
will place 8 logarithmically spaced minor ticks between
<emclass="property">class </em><codeclass="descname">InvertedLog10Transform</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLog10Transform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">base</code><emclass="property"> = 10.0</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLog10Transform.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLog10Transform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLog10Transform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<emclass="property">class </em><codeclass="descname">InvertedLog2Transform</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLog2Transform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">base</code><emclass="property"> = 2.0</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLog2Transform.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLog2Transform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLog2Transform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<emclass="property">class </em><codeclass="descname">InvertedLogTransform</code><spanclass="sig-paren">(</span><em><spanclass="n">base</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLogTransform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">has_inverse</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLogTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLogTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLogTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<codeclass="descname">is_separable</code><emclass="property"> = True</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLogTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLogTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLogTransform.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 notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<emclass="property">class </em><codeclass="descname">InvertedNaturalLogTransform</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedNaturalLogTransform" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>shorthand_name</strong><spanclass="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<codeclass="docutils literal notranslate"><spanclass="pre">str(transform)</span></code> when DEBUG=True.</p>
<codeclass="descname">base</code><emclass="property"> = 2.718281828459045</em><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedNaturalLogTransform.base" title="Permalink to this definition">¶</a></dt>