# Documentation

### This is machine translation

Translated by
Mouse over text to see original. Click the button below to return to the English verison of the page.

# prob.RicianDistribution class

Package: prob
Superclasses: prob.ToolboxFittableParametricDistribution

Rician probability distribution object

## Description

`prob.RicianDistribution` is an object consisting of parameters, a model description, and sample data for a Rician probability distribution.

Create a probability distribution object with specified parameter values using `makedist`. Alternatively, fit a distribution to data using `fitdist` or the Distribution Fitting app.

## Construction

`pd = makedist('Rician')` creates a Rician probability distribution object using the default parameter values.

`pd = makedist('Rician','s',s,'sigma',sigma)` creates a Rician probability distribution object using the specified parameter values.

### Input Arguments

expand all

Noncentrality parameter for the Rician distribution, specified as a nonnegative scalar value.

Data Types: `single` | `double`

Scale parameter for the Rician distribution, specified as a positive scalar value.

Data Types: `single` | `double`

## Properties

expand all

Noncentrality parameter of the Rician distribution, stored as a nonnegative scalar value.

Data Types: `single` | `double`

Scale parameter for the Rician distribution, stored as a positive scalar value.

Data Types: `single` | `double`

Probability distribution name, stored as a character vector. This property is read-only.

Data Types: `char`

Data used for distribution fitting, stored as a structure containing the following:

• `data`: Data vector used for distribution fitting.

• `cens`: Censoring vector, or empty if none.

• `freq`: Frequency vector, or empty if none.

Data Types: `struct`

Logical flag for truncated distribution, stored as a logical value. If `IsTruncated` equals `0`, the distribution is not truncated. If `IsTruncated` equals `1`, the distribution is truncated. This property is read-only.

Data Types: `logical`

Number of parameters for the probability distribution, stored as a positive integer value. This property is read-only.

Data Types: `single` | `double`

Covariance matrix of the parameter estimates, stored as a p-by-p matrix, where p is the number of parameters in the distribution. The (`i`,`j`) element is the covariance between the estimates of the `i`th parameter and the `j`th parameter. The (`i`,`i`) element is the estimated variance of the `i`th parameter. If parameter `i` is fixed rather than estimated by fitting the distribution to data, then the (`i`,`i`) elements of the covariance matrix are 0. This property is read-only.

Data Types: `single` | `double`

Distribution parameter descriptions, stored as a cell array of character vectors. Each cell contains a short description of one distribution parameter. This property is read-only.

Data Types: `char`

Logical flag for fixed parameters, stored as an array of logical values. If `0`, the corresponding parameter in the `ParameterNames` array is not fixed. If `1`, the corresponding parameter in the `ParameterNames` array is fixed. This property is read-only.

Data Types: `logical`

Distribution parameter names, stored as a cell array of character vectors. This property is read-only.

Data Types: `char`

Distribution parameter values, stored as a vector. This property is read-only.

Data Types: `single` | `double`

Truncation interval for the probability distribution, stored as a vector containing the lower and upper truncation boundaries. This property is read-only.

Data Types: `single` | `double`

## Methods

### Inherited Methods

 cdf Cumulative distribution function of probability distribution object icdf Inverse cumulative distribution function of probability distribution object iqr Interquartile range of probability distribution object median Median of probability distribution object pdf Probability density function of probability distribution object random Generate random numbers from probability distribution object truncate Truncate probability distribution object
 mean Mean of probability distribution object negloglik Negative log likelihood of probability distribution object paramci Confidence intervals for probability distribution parameters proflik Profile likelihood function for probability distribution object std Standard deviation of probability distribution object var Variance of probability distribution object

## Definitions

### Rician Distribution

The Rician distribution is used in communications theory to model scattered signals that reach a receiver using multiple paths.

The Rician distribution uses the following parameters.

NameDescriptionSupport
`s`Noncentrality parameter$s\ge 0$
`sigma`Scale parameter$\sigma >0$

The probability density function (pdf) is

`$f\left(x|s,\sigma \right)={I}_{0}\left(\frac{xs}{{\sigma }^{2}}\right)\left(\frac{x}{{\sigma }^{2}}\right)\mathrm{exp}\left\{-\frac{{x}^{2}+{s}^{2}}{2{\sigma }^{2}}\right\}\text{ };\text{ }x\ge 0\text{\hspace{0.17em}},$`

where I0 is the zero-order modified Bessel function of the first kind.

## Examples

expand all

Create a Rician distribution object using the default parameter values.

`pd = makedist('Rician')`
```pd = RicianDistribution Rician distribution s = 1 sigma = 1```

Create a Rician distribution object by specifying the parameter values.

`pd = makedist('Rician','s',0,'sigma',2)`
```pd = RicianDistribution Rician distribution s = 0 sigma = 2```

Compute the mean of the distribution.

`m = mean(pd)`
```m = 2.5066```