scipy.stats.wrapcauchy

scipy.stats.wrapcauchy()

A wrapped Cauchy continuous random variable.

Continuous random variables are defined from a standard form and may require some shape parameters to complete its specification. Any optional keyword parameters can be passed to the methods of the RV object as given below:

Parameters:

x : array-like

quantiles

q : array-like

lower or upper tail probability

c : array-like

shape parameters

loc : array-like, optional

location parameter (default=0)

scale : array-like, optional

scale parameter (default=1)

size : int or tuple of ints, optional

shape of random variates (default computed from input arguments )

moments : string, optional

composed of letters [‘mvsk’] specifying which moments to compute where ‘m’ = mean, ‘v’ = variance, ‘s’ = (Fisher’s) skew and ‘k’ = (Fisher’s) kurtosis. (default=’mv’)

Methods:

wrapcauchy.rvs(c,loc=0,scale=1,size=1) :

• random variates

wrapcauchy.pdf(x,c,loc=0,scale=1) :

• probability density function

wrapcauchy.cdf(x,c,loc=0,scale=1) :

• cumulative density function

wrapcauchy.sf(x,c,loc=0,scale=1) :

• survival function (1-cdf — sometimes more accurate)

wrapcauchy.ppf(q,c,loc=0,scale=1) :

• percent point function (inverse of cdf — percentiles)

wrapcauchy.isf(q,c,loc=0,scale=1) :

• inverse survival function (inverse of sf)

wrapcauchy.stats(c,loc=0,scale=1,moments=’mv’) :

• mean(‘m’), variance(‘v’), skew(‘s’), and/or kurtosis(‘k’)

wrapcauchy.entropy(c,loc=0,scale=1) :

• (differential) entropy of the RV.

wrapcauchy.fit(data,c,loc=0,scale=1) :

• Parameter estimates for wrapcauchy data

Alternatively, the object may be called (as a function) to fix the shape, :

location, and scale parameters returning a “frozen” continuous RV object: :

rv = wrapcauchy(c,loc=0,scale=1) :

• frozen RV object with the same methods but holding the given shape, location, and scale fixed

Examples

>>> import matplotlib.pyplot as plt
>>> numargs = wrapcauchy.numargs
>>> [ c ] = [0.9,]*numargs
>>> rv = wrapcauchy(c)

Display frozen pdf

>>> x = np.linspace(0,np.minimum(rv.dist.b,3))
>>> h=plt.plot(x,rv.pdf(x))

Check accuracy of cdf and ppf

>>> prb = wrapcauchy.cdf(x,c)
>>> h=plt.semilogy(np.abs(x-wrapcauchy.ppf(prb,c))+1e-20)

Random number generation

>>> R = wrapcauchy.rvs(c,size=100)

Wrapped Cauchy distribution

wrapcauchy.pdf(x,c) = (1-c**2) / (2*pi*(1+c**2-2*c*cos(x))) for 0 <= x <= 2*pi, 0 < c < 1.