scipy.stats.johnsonsu — SciPy v1.15.2 Manual (original) (raw)

scipy.stats.johnsonsu = <scipy.stats._continuous_distns.johnsonsu_gen object>[source]#

A Johnson SU continuous random variable.

As an instance of the rv_continuous class, johnsonsu object inherits from it a collection of generic methods (see below for the full list), and completes them with details specific for this particular distribution.

Notes

The probability density function for johnsonsu is:

\[f(x, a, b) = \frac{b}{\sqrt{x^2 + 1}} \phi(a + b \log(x + \sqrt{x^2 + 1}))\]

where \(x\), \(a\), and \(b\) are real scalars; \(b > 0\).\(\phi\) is the pdf of the normal distribution.

johnsonsu takes \(a\) and \(b\) as shape parameters.

The first four central moments are calculated according to the formulas in [1].

The probability density above is defined in the “standardized” form. To shift and/or scale the distribution use the loc and scale parameters. Specifically, johnsonsu.pdf(x, a, b, loc, scale) is identically equivalent to johnsonsu.pdf(y, a, b) / scale withy = (x - loc) / scale. Note that shifting the location of a distribution does not make it a “noncentral” distribution; noncentral generalizations of some distributions are available in separate classes.

References

Examples

import numpy as np from scipy.stats import johnsonsu import matplotlib.pyplot as plt fig, ax = plt.subplots(1, 1)

Calculate the first four moments:

a, b = 2.55, 2.25 mean, var, skew, kurt = johnsonsu.stats(a, b, moments='mvsk')

Display the probability density function (pdf):

x = np.linspace(johnsonsu.ppf(0.01, a, b), ... johnsonsu.ppf(0.99, a, b), 100) ax.plot(x, johnsonsu.pdf(x, a, b), ... 'r-', lw=5, alpha=0.6, label='johnsonsu pdf')

Alternatively, the distribution object can be called (as a function) to fix the shape, location and scale parameters. This returns a “frozen” RV object holding the given parameters fixed.

Freeze the distribution and display the frozen pdf:

rv = johnsonsu(a, b) ax.plot(x, rv.pdf(x), 'k-', lw=2, label='frozen pdf')

Check accuracy of cdf and ppf:

vals = johnsonsu.ppf([0.001, 0.5, 0.999], a, b) np.allclose([0.001, 0.5, 0.999], johnsonsu.cdf(vals, a, b)) True

Generate random numbers:

r = johnsonsu.rvs(a, b, size=1000)

And compare the histogram:

ax.hist(r, density=True, bins='auto', histtype='stepfilled', alpha=0.2) ax.set_xlim([x[0], x[-1]]) ax.legend(loc='best', frameon=False) plt.show()

../../_images/scipy-stats-johnsonsu-1.png

Methods

rvs(a, b, loc=0, scale=1, size=1, random_state=None) Random variates.
pdf(x, a, b, loc=0, scale=1) Probability density function.
logpdf(x, a, b, loc=0, scale=1) Log of the probability density function.
cdf(x, a, b, loc=0, scale=1) Cumulative distribution function.
logcdf(x, a, b, loc=0, scale=1) Log of the cumulative distribution function.
sf(x, a, b, loc=0, scale=1) Survival function (also defined as 1 - cdf, but sf is sometimes more accurate).
logsf(x, a, b, loc=0, scale=1) Log of the survival function.
ppf(q, a, b, loc=0, scale=1) Percent point function (inverse of cdf — percentiles).
isf(q, a, b, loc=0, scale=1) Inverse survival function (inverse of sf).
moment(order, a, b, loc=0, scale=1) Non-central moment of the specified order.
stats(a, b, loc=0, scale=1, moments=’mv’) Mean(‘m’), variance(‘v’), skew(‘s’), and/or kurtosis(‘k’).
entropy(a, b, loc=0, scale=1) (Differential) entropy of the RV.
fit(data) Parameter estimates for generic data. See scipy.stats.rv_continuous.fit for detailed documentation of the keyword arguments.
expect(func, args=(a, b), loc=0, scale=1, lb=None, ub=None, conditional=False, **kwds) Expected value of a function (of one argument) with respect to the distribution.
median(a, b, loc=0, scale=1) Median of the distribution.
mean(a, b, loc=0, scale=1) Mean of the distribution.
var(a, b, loc=0, scale=1) Variance of the distribution.
std(a, b, loc=0, scale=1) Standard deviation of the distribution.
interval(confidence, a, b, loc=0, scale=1) Confidence interval with equal areas around the median.