The transforms API

transforms API Reference

class probscale.transforms.ProbTransform(dist, as_pct=True, out_of_bounds='mask')

Bases: probscale.transforms._ProbTransformMixin

MPL axes tranform class to convert quantiles to probabilities or percents.

Parameters:

dist : scipy.stats distribution

The distribution whose cdf and pdf methods wiil set the scale of the axis.

as_pct : bool, optional (True)

Toggles the formatting of the probabilities associated with the tick labels as percentanges (0 - 100) or fractions (0 - 1).

out_of_bounds : string, optionals (‘mask’ or ‘clip’)

Determines how data outside the range of valid values is handled. The default behavior is to mask the data. Alternatively, the data can be clipped to values arbitrarily close to the limits of the scale.

transform_non_affine(prob)

inverted()

class probscale.transforms.QuantileTransform(dist, as_pct=True, out_of_bounds='mask')

Bases: probscale.transforms._ProbTransformMixin

MPL axes tranform class to convert probabilities or percents to quantiles.

Parameters:

dist : scipy.stats distribution

The distribution whose cdf and pdf methods wiil set the scale of the axis.

as_pct : bool, optional (True)

Toggles the formatting of the probabilities associated with the tick labels as percentanges (0 - 100) or fractions (0 - 1).

out_of_bounds : string, optionals (‘mask’ or ‘clip’)

Determines how data outside the range of valid values is handled. The default behavior is to mask the data. Alternatively, the data can be clipped to values arbitrarily close to the limits of the scale.

transform_non_affine(q)

inverted()