scipy.stats.wrapcauchy¶
- scipy.stats.wrapcauchy = <scipy.stats._continuous_distns.wrapcauchy_gen object at 0x2b2318ee65d0>[source]¶
A wrapped Cauchy continuous random variable.
As an instance of the rv_continuous class, wrapcauchy 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 wrapcauchy is:
wrapcauchy.pdf(x, c) = (1-c**2) / (2*pi*(1+c**2-2*c*cos(x)))
for 0 <= x <= 2*pi, 0 < c < 1.
wrapcauchy takes c as a shape parameter.
The probability density above is defined in the “standardized” form. To shift and/or scale the distribution use the loc and scale parameters. Specifically, wrapcauchy.pdf(x, c, loc, scale) is identically equivalent to wrapcauchy.pdf(y, c) / scale with y = (x - loc) / scale.
Examples
>>> from scipy.stats import wrapcauchy >>> import matplotlib.pyplot as plt >>> fig, ax = plt.subplots(1, 1)
Calculate a few first moments:
>>> c = 0.0311 >>> mean, var, skew, kurt = wrapcauchy.stats(c, moments='mvsk')
Display the probability density function (pdf):
>>> x = np.linspace(wrapcauchy.ppf(0.01, c), ... wrapcauchy.ppf(0.99, c), 100) >>> ax.plot(x, wrapcauchy.pdf(x, c), ... 'r-', lw=5, alpha=0.6, label='wrapcauchy 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 = wrapcauchy(c) >>> ax.plot(x, rv.pdf(x), 'k-', lw=2, label='frozen pdf')
Check accuracy of cdf and ppf:
>>> vals = wrapcauchy.ppf([0.001, 0.5, 0.999], c) >>> np.allclose([0.001, 0.5, 0.999], wrapcauchy.cdf(vals, c)) True
Generate random numbers:
>>> r = wrapcauchy.rvs(c, size=1000)
And compare the histogram:
>>> ax.hist(r, normed=True, histtype='stepfilled', alpha=0.2) >>> ax.legend(loc='best', frameon=False) >>> plt.show()
Methods
rvs(c, loc=0, scale=1, size=1, random_state=None) Random variates. pdf(x, c, loc=0, scale=1) Probability density function. logpdf(x, c, loc=0, scale=1) Log of the probability density function. cdf(x, c, loc=0, scale=1) Cumulative distribution function. logcdf(x, c, loc=0, scale=1) Log of the cumulative distribution function. sf(x, c, loc=0, scale=1) Survival function (also defined as 1 - cdf, but sf is sometimes more accurate). logsf(x, c, loc=0, scale=1) Log of the survival function. ppf(q, c, loc=0, scale=1) Percent point function (inverse of cdf — percentiles). isf(q, c, loc=0, scale=1) Inverse survival function (inverse of sf). moment(n, c, loc=0, scale=1) Non-central moment of order n stats(c, loc=0, scale=1, moments='mv') Mean(‘m’), variance(‘v’), skew(‘s’), and/or kurtosis(‘k’). entropy(c, loc=0, scale=1) (Differential) entropy of the RV. fit(data, c, loc=0, scale=1) Parameter estimates for generic data. expect(func, args=(c,), 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(c, loc=0, scale=1) Median of the distribution. mean(c, loc=0, scale=1) Mean of the distribution. var(c, loc=0, scale=1) Variance of the distribution. std(c, loc=0, scale=1) Standard deviation of the distribution. interval(alpha, c, loc=0, scale=1) Endpoints of the range that contains alpha percent of the distribution