scipy.stats.rice

scipy.stats.rice()

A Rice 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

b : 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:

rice.rvs(b,loc=0,scale=1,size=1) :

• random variates

rice.pdf(x,b,loc=0,scale=1) :

• probability density function

rice.cdf(x,b,loc=0,scale=1) :

• cumulative density function

rice.sf(x,b,loc=0,scale=1) :

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

rice.ppf(q,b,loc=0,scale=1) :

• percent point function (inverse of cdf — percentiles)

rice.isf(q,b,loc=0,scale=1) :

• inverse survival function (inverse of sf)

rice.stats(b,loc=0,scale=1,moments=’mv’) :

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

rice.entropy(b,loc=0,scale=1) :

• (differential) entropy of the RV.

rice.fit(data,b,loc=0,scale=1) :

• Parameter estimates for rice 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 = rice(b,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 = rice.numargs
>>> [ b ] = [0.9,]*numargs
>>> rv = rice(b)

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 = rice.cdf(x,b)
>>> h=plt.semilogy(np.abs(x-rice.ppf(prb,c))+1e-20)

Random number generation

>>> R = rice.rvs(b,size=100)

Rician distribution

rice.pdf(x,b) = x * exp(-(x**2+b**2)/2) * I[0](x*b) for x > 0, b > 0.