Accelerating the pace of engineering and science

# Documentation Center

• Trial Software

# 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.

expand all

### s — Noncentrality parameter1 (default) | nonnegative scalar value

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

Data Types: single | double

### sigma — scale parameter1 (default) | positive scalar value

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

Data Types: single | double

## Properties

 s Noncentrality parameter of the Rician distribution, stored as a nonnegative scalar value. sigma Scale parameter for the Rician distribution, stored as a positive scalar value. DistributionName Name of the probability distribution, stored as a valid probability distribution name string. This property is read-only. InputData 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. This property is read-only. IsTruncated 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. NumParameters Number of parameters for the probability distribution, stored as a positive integer value. This property is read-only. ParameterCovariance 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 ith parameter and the jth parameter. The (i,i) element is the estimated variance of the ith 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. ParameterDescription Descriptions of distribution parameters, stored as a cell array of strings. Each cell contains a short description of one distribution parameter. This property is read-only. ParameterIsFixed 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. ParameterNames Names of distribution parameters, stored as a cell array of strings. This property is read-only. ParameterValues Values of distribution parameters, stored as a vector. This property is read-only. Truncation Truncation interval for the probability distribution, stored as a vector containing the lower and upper truncation boundaries. This property is read-only.

## 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 loglikelihood 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
sNoncentrality parameter
sigmaScale parameter

The probability density function (pdf) is

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

## Examples

expand all

### Create a Rician Distribution Object Using Default Parameters

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 Using Specified Parameters

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```