Accelerating the pace of engineering and science

# prob.RayleighDistribution class

Package: prob
Superclasses: prob.ToolboxFittableParametricDistribution

Rayleigh probability distribution object

## Description

prob.RayleighDistribution is an object consisting of parameters, a model description, and sample data for a normal 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('Rayleigh') creates a Rayleigh probability distribution object using the default parameter values.

pd = makedist('Rayleigh','b',b) creates a Rayleigh probability distribution object using the specified parameter value.

expand all

### b — Defining parameter1 (default) | positive scalar value

Defining parameter for the Rayleigh distribution, specified as a positive scalar value.

Data Types: single | double

## Properties

expand all

### b — Defining parameterpositive scalar value

Defining parameter for the Rayleigh distribution, stored as a positive scalar value.

Data Types: single | double

### DistributionName — Probability distribution nameprobability distribution name string

Probability distribution name, stored as a valid probability distribution name string. This property is read-only.

Data Types: char

### InputData — Data used for distribution fittingstructure

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

### IsTruncated — Logical flag for truncated distribution0 | 1

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

### NumParameters — Number of parameterspositive integer value

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

Data Types: single | double

### ParameterCovariance — Covariance matrix of the parameter estimatesmatrix of scalar values

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.

Data Types: single | double

### ParameterDescription — Distribution parameter descriptionscell array of strings

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

Data Types: char

### ParameterIsFixed — Logical flag for fixed parametersarray of logical values

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

### ParameterNames — Distribution parameter namescell array of strings

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

Data Types: char

### ParameterValues — Distribution parameter valuesvector of scalar values

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

Data Types: single | double

### Truncation — Truncation intervalvector of scalar values

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

### Rayleigh Distribution

The Rayleigh distribution is a special case of the Weibull distribution. It is often used in communication theory to model scattered signals that reach a receiver by multiple paths.

The Rayleigh distribution uses the following parameter.

ParameterDescriptionSupport
bDefining parameter$b>0$

The probability density function (pdf) is

$f\left(x|b\right)=\frac{x}{{b}^{2}}\mathrm{exp}\left\{\frac{-{x}^{2}}{2{b}^{2}}\right\}\text{ };\text{ }x\ge 0\text{\hspace{0.17em}}.$

## Examples

expand all

### Create a Rayleigh Distribution Object Using Default Parameters

Create a Rayleigh distribution object using the default parameter values.

`pd = makedist('Rayleigh')`
```pd =

RayleighDistribution

Rayleigh distribution
B = 1```

### Create a Rayleigh Distribution Object Using Specified Parameters

Create a Rayleigh distribution object by specifying the parameter values.

`pd = makedist('Rayleigh','b',3)`
```pd =

RayleighDistribution

Rayleigh distribution
B = 3```

Compute the mean of the distribution.

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

3.7599```