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.4.3). 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><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">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, default: 10</span></dt><dd><p>Logarithmic base of the scale.</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><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><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">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>Apply only the non-affine part of this 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>array</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.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><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">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>Apply only the non-affine part of this transformation.</p>
<p><codeclass="docutils literal notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to
<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><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">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>Apply only the non-affine part of this 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>array</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><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><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">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.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>base</strong><spanclass="classifier">float, default: 10</span></dt><dd><p>The base of the logarithm.</p>
</dd>
<dt><strong>nonpositive</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>subs</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 each major tick.</p>
<emclass="property">property </em><codeclass="descname">InvertedLogTransform</code><aclass="headerlink" href="#matplotlib.scale.LogScale.InvertedLogTransform" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.scale.LogScale.LogTransform">
<emclass="property">property </em><codeclass="descname">LogTransform</code><aclass="headerlink" href="#matplotlib.scale.LogScale.LogTransform" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.scale.LogScale.base">
<emclass="property">property </em><codeclass="descname">base</code><aclass="headerlink" href="#matplotlib.scale.LogScale.base" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.scale.LogScale.get_transform">
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogScale.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogScale.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="#matplotlib.scale.LogScale.LogTransform" title="matplotlib.scale.LogScale.LogTransform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">LogTransform</span></code></a> associated with this scale.</p>
<codeclass="descname">limit_range_for_scale</code><spanclass="sig-paren">(</span><em><spanclass="n">vmin</span></em>, <em><spanclass="n">vmax</span></em>, <em><spanclass="n">minpos</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogScale.limit_range_for_scale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogScale.limit_range_for_scale" title="Permalink to this definition">¶</a></dt>
<dd><p>Limit the domain to positive values.</p>
</dd></dl>
<dlclass="py attribute">
<dtid="matplotlib.scale.LogScale.name">
<codeclass="descname">name</code><emclass="property"> = 'log'</em><aclass="headerlink" href="#matplotlib.scale.LogScale.name" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_default_locators_and_formatters</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogScale.set_default_locators_and_formatters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogScale.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.LogTransform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">LogTransform</code><spanclass="sig-paren">(</span><em><spanclass="n">base</span></em>, <em><spanclass="n">nonpositive</span><spanclass="o">=</span><spanclass="default_value">'clip'</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogTransform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogTransform" 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.LogTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py attribute">
<dtid="matplotlib.scale.LogTransform.input_dims">
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.LogTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.scale.LogTransform.inverted">
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogTransform.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.LogTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.LogTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogTransform.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply only the non-affine part of this 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>array</dt><dd><p>The output values as NumPy array of length <aclass="reference internal" href="#matplotlib.scale.LogTransform.input_dims" title="matplotlib.scale.LogTransform.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.LogTransform.output_dims" title="matplotlib.scale.LogTransform.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.LogisticTransform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">LogisticTransform</code><spanclass="sig-paren">(</span><em><spanclass="n">nonpositive</span><spanclass="o">=</span><spanclass="default_value">'mask'</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogisticTransform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogisticTransform" 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.LogisticTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.LogisticTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogisticTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogisticTransform.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.LogisticTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.LogisticTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogisticTransform.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogisticTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>logistic transform (base 10)</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.LogitScale">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">LogitScale</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em>, <em><spanclass="n">nonpositive</span><spanclass="o">=</span><spanclass="default_value">'mask'</span></em>, <em><spanclass="o">*</span></em>, <em><spanclass="n">one_half</span><spanclass="o">=</span><spanclass="default_value">'\x0crac{1}{2}'</span></em>, <em><spanclass="n">use_overline</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogitScale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogitScale" title="Permalink to this definition">¶</a></dt>
<dt><strong>nonpositive</strong><spanclass="classifier">{'mask', 'clip'}</span></dt><dd><p>Determines the behavior for values beyond the open interval ]0, 1[.
They can either be masked as invalid, or clipped to a number very
close to 0 or 1.</p>
</dd>
<dt><strong>use_overline</strong><spanclass="classifier">bool, default: False</span></dt><dd><p>Indicate the usage of survival notation (overline{x}) in place of
standard notation (1-x) for probability close to one.</p>
</dd>
<dt><strong>one_half</strong><spanclass="classifier">str, default: r"frac{1}{2}"</span></dt><dd><p>The string used for ticks formatter to represent 1/2.</p>
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogitScale.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogitScale.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="#matplotlib.scale.LogitTransform" title="matplotlib.scale.LogitTransform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">LogitTransform</span></code></a> associated with this scale.</p>
<codeclass="descname">limit_range_for_scale</code><spanclass="sig-paren">(</span><em><spanclass="n">vmin</span></em>, <em><spanclass="n">vmax</span></em>, <em><spanclass="n">minpos</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogitScale.limit_range_for_scale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogitScale.limit_range_for_scale" title="Permalink to this definition">¶</a></dt>
<dd><p>Limit the domain to values between 0 and 1 (excluded).</p>
</dd></dl>
<dlclass="py attribute">
<dtid="matplotlib.scale.LogitScale.name">
<codeclass="descname">name</code><emclass="property"> = 'logit'</em><aclass="headerlink" href="#matplotlib.scale.LogitScale.name" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_default_locators_and_formatters</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogitScale.set_default_locators_and_formatters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogitScale.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.LogitTransform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">LogitTransform</code><spanclass="sig-paren">(</span><em><spanclass="n">nonpositive</span><spanclass="o">=</span><spanclass="default_value">'mask'</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogitTransform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogitTransform" 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.LogitTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.LogitTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.scale.LogitTransform.inverted">
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogitTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogitTransform.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.LogitTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.LogitTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#LogitTransform.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.LogitTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>logit transform (base 10), masked or clipped</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.scale.ScaleBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">ScaleBase</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#ScaleBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.ScaleBase" title="Permalink to this definition">¶</a></dt>
<p>The following note is for scale implementors.</p>
<p>For back-compatibility reasons, scales take 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>
object as first argument. However, this argument should not
be used: a single scale object should be usable by multiple
<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>es at the same time.</p>
<dlclass="py method">
<dtid="matplotlib.scale.ScaleBase.get_transform">
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#ScaleBase.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.ScaleBase.get_transform" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">limit_range_for_scale</code><spanclass="sig-paren">(</span><em><spanclass="n">vmin</span></em>, <em><spanclass="n">vmax</span></em>, <em><spanclass="n">minpos</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#ScaleBase.limit_range_for_scale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.ScaleBase.limit_range_for_scale" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the range <em>vmin</em>, <em>vmax</em>, restricted to the
domain supported by this scale (if any).</p>
<p><em>minpos</em> should be the minimum positive value in the data.
This is used by log scales to determine a minimum value.</p>
<codeclass="descname">set_default_locators_and_formatters</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#ScaleBase.set_default_locators_and_formatters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.ScaleBase.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.SymmetricalLogScale">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">SymmetricalLogScale</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#SymmetricalLogScale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale" 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>base</strong><spanclass="classifier">float, default: 10</span></dt><dd><p>The base of the logarithm.</p>
</dd>
<dt><strong>linthresh</strong><spanclass="classifier">float, default: 2</span></dt><dd><p>Defines the range <codeclass="docutils literal notranslate"><spanclass="pre">(-x,</span><spanclass="pre">x)</span></code>, within which the plot is linear.
This avoids having the plot go to infinity around zero.</p>
</dd>
<dt><strong>subs</strong><spanclass="classifier">sequence of int</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 each major tick.</p>
</dd>
<dt><strong>linscale</strong><spanclass="classifier">float, optional</span></dt><dd><p>This allows the linear range <codeclass="docutils literal notranslate"><spanclass="pre">(-linthresh,</span><spanclass="pre">linthresh)</span></code> to be
stretched relative to the logarithmic range. Its value is the number of
decades to use for each half of the linear range. For example, when
<em>linscale</em> == 1.0 (the default), the space used for the positive and
negative halves of the linear range will be equal to one decade in
the logarithmic range.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p>Construct a new scale.</p>
<pclass="rubric">Notes</p>
<p>The following note is for scale implementors.</p>
<p>For back-compatibility reasons, scales take 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>
object as first argument. However, this argument should not
be used: a single scale object should be usable by multiple
<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>es at the same time.</p>
<emclass="property">property </em><codeclass="descname">InvertedSymmetricalLogTransform</code><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale.InvertedSymmetricalLogTransform" title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="descname">SymmetricalLogTransform</code><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale.SymmetricalLogTransform" title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="descname">base</code><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale.base" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#SymmetricalLogScale.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="#matplotlib.scale.SymmetricalLogScale.SymmetricalLogTransform" title="matplotlib.scale.SymmetricalLogScale.SymmetricalLogTransform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">SymmetricalLogTransform</span></code></a> associated with this scale.</p>
<emclass="property">property </em><codeclass="descname">linscale</code><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale.linscale" title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="descname">linthresh</code><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale.linthresh" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">name</code><emclass="property"> = 'symlog'</em><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale.name" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_default_locators_and_formatters</code><spanclass="sig-paren">(</span><em><spanclass="n">axis</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#SymmetricalLogScale.set_default_locators_and_formatters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogScale.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.SymmetricalLogTransform">
<emclass="property">class </em><codeclass="descclassname">matplotlib.scale.</code><codeclass="descname">SymmetricalLogTransform</code><spanclass="sig-paren">(</span><em><spanclass="n">base</span></em>, <em><spanclass="n">linthresh</span></em>, <em><spanclass="n">linscale</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#SymmetricalLogTransform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogTransform" 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.SymmetricalLogTransform.has_inverse" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">input_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogTransform.input_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverted</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#SymmetricalLogTransform.inverted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogTransform.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.SymmetricalLogTransform.is_separable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">output_dims</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogTransform.output_dims" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">transform_non_affine</code><spanclass="sig-paren">(</span><em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/scale.html#SymmetricalLogTransform.transform_non_affine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.scale.SymmetricalLogTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply only the non-affine part of this transformation.</p>
<p><codeclass="docutils literal notranslate"><spanclass="pre">transform(values)</span></code> is always equivalent to