dsp.Mean

(To be removed) Find mean value of input or sequence of inputs

Description

The dsp.Mean object finds the mean of an input or sequence of inputs.

Note

The dsp.Mean System object™ will be removed in a future release. To compute the mean, use the mean function. To compute the running mean in MATLAB^®, use the dsp.MovingAverage object. For more information, see Compatibility Considerations.

To compute the mean of an input or sequence of inputs:

Create the dsp.Mean object and set its properties.
Call the object with arguments, as if it were a function.

To learn more about how System objects work, see What Are System Objects? (MATLAB).

Creation

Syntax

mn = dsp.Mean

mn = dsp.Mean(Name,Value)

Description

mn = dsp.Mean returns an object, mn, that computes the mean of an input or a sequence of inputs.

mn = dsp.Mean(Name,Value) returns a mean-finding object, mn, with each specified property set to the specified value.

Properties

expand all

Unless otherwise indicated, properties are nontunable, which means you cannot change their values after calling the object. Objects lock when you call them, and the release function unlocks them.

If a property is tunable, you can change its value at any time.

For more information on changing property values, see System Design in MATLAB Using System Objects (MATLAB).

`RunningMean` — Calculate over single input or multiple inputs
`false` (default) | `true`

When you set this property to true, the object calculates the mean over successive calls to the algorithm. When you set this property to false, the object computes the mean over the current input.

`ResetInputPort` — Additional input to enable resetting of running mean
`false` (default) | `true`

Set this property to true to enable resetting of the running mean. When you set this property to true, you must specify a reset input to the algorithm to reset the running mean.

Dependencies

This property applies only when you set the RunningMean property to true.

`ResetCondition` — Condition that triggers resetting of running mean
`Non-zero` (default) | `Rising edge` | `Falling edge` | `Either edge`

Specify the event that resets the running maximum.

Dependencies

This property applies only when you set the ResetInputPort property to true.

`Dimension` — Dimension to operate along
`Column` (default) | `All` | `Row` | `Custom`

Specify how the mean calculation is performed over the data.

Dependencies

This property applies when you set the RunningMean property to false.

`CustomDimension` — Numerical dimension to calculate over
`1` (default) | positive integer

Specify the integer dimension, indexed from one, of the input signal over which the object calculates the mean. The value cannot exceed the number of dimensions in the input signal.

Dependencies

This property only applies when you set the Dimension property to Custom.

Fixed-Point Properties

`RoundingMethod` — Rounding method for fixed-point operations
`Floor` (default) | `Ceiling` | `Convergent` | `Nearest` | `Round` | `Simplest` | `Zero`

Specify the rounding method.

`OverflowAction` — Action to take when integer input is out of range
`Wrap` (default) | `Saturate`

Specify the overflow action.

`AccumulatorDataType` — Data type of accumulator
`Same as input` (default) | `Custom`

Specify the accumulator fixed-point data type.

`CustomAccumulatorDataType` — Accumulator word and fraction lengths
`numerictype([],32,30)` (default) | numerictype

Specify the accumulator fixed-point type as a scaled numerictype object with a Signedness of Auto.

Dependencies

This property applies only when you set the AccumulatorDataType property to Custom.

`OutputDataType` — Data type of output
`Same as accumulator` (default) | `Same as input` | `Custom`

Specify the output fixed-point data type.

`CustomOutputDataType` — Output word and fraction lengths
`numerictype([],32,30)` (default) | numerictype

Specify the output fixed-point type as a scaled numerictype object with a Signedness of Auto.

Dependencies

This property applies only when you set the OutputDataType property to Custom.

Usage

Syntax

y = mn(x)

y = mn(x,r)

Description

y = mn(x) computes the mean of x. When you set the RunningMean property to true, y is the mean calculated over successive calls to the algorithm.

y = mn(x,r) resets the computation of the running mean based on the value of the reset signal, r, and the ResetCondition property. To enable this type of processing, set the RunningMean property to true and the ResetInputPort property to true.

Input Arguments

expand all

`x` — Data input
vector | matrix

Data input, specified as a vector or a matrix. If x is a matrix, each column is treated as an independent channel. The mean is computed along each channel. The object also accepts variable-size inputs. Once the object is locked, you can change the size of each input channel.

`r` — Reset signal
scalar

Reset signal used to reset the running mean, specified as a scalar value. The object resets the running mean if the reset signal satisfies the ResetCondition.

Dependencies

To enable this signal, set the RunningMean property to true and the ResetInputPort property to true.

Output Arguments

expand all

`y` — Mean
scalar | vector | matrix

Mean output of the input signal, returned as a scalar, vector, or a matrix. If RunningMean is set to:

false –– The object computes the mean value of each input channel. If the input is a column vector, the output is a scalar. If the input is a multichannel signal, the output signal is 1-by-N vector, where N is the number of input channels.
true –– The object computes the running mean of the signal. The size of the output signal matches the size of the input signal.

Object Functions

To use an object function, specify the System object as the first input argument. For example, to release system resources of a System object named obj, use this syntax:

release(obj)

expand all

Common to All System Objects

`step`	Run System object algorithm
`release`	Release resources and allow changes to System object property values and input characteristics
`reset`	Reset internal states of System object

Examples

Compute Mean and Running Mean of Signal

Note: If you are using R2016a or an earlier release, replace each call to the object with the equivalent step syntax. For example, obj(x) becomes step(obj,x).

Mean

mean1 = dsp.Mean;
x = randn(100,1);
y = mean1(x);

Running Mean

mean2 = dsp.Mean;
mean2.RunningMean = true;
x = randn(100,1);
yrmean = mean2(x);

Algorithms

This object implements the algorithm, inputs, and outputs described on the Mean block reference page. The object properties correspond to the block parameters.

Compatibility Considerations

expand all

`dsp.Mean` System object will be removed

Warns starting in R2019b

The dsp.Mean System object will be removed in a future release. To compute the mean, use the mean function. To compute the running mean, use the dsp.MovingAverage object.

Update Code

This table shows typical usage of the System object and explains how to update existing code to use the equivalent function.

Discouraged Usage Recommended Replacement

Discouraged Usage	Recommended Replacement
Mean Mean1 = dsp.Mean; x = randn(100,1); y = Mean1(x); Running Mean Mean2 = dsp.Mean; Mean2.RunningMean = true; x = randn(100,1); % Running mean y = Mean2(x); If you are using a release prior to R2016b, replace `Mean1(x)` with `step(Mean1,x)` and `Mean2(x)` with `step(Mean2,x)`.	Mean x = randn(100,1); y = mean(x); Running Mean mvgAvg = dsp.MovingAverage; mvgAvg.SpecifyWindowLength = false; x = randn(100,1); y = mvgAvg(x);

Mean

Mean1 = dsp.Mean;
x = randn(100,1);
y = Mean1(x);

Running Mean

Mean2 = dsp.Mean;
Mean2.RunningMean = true;
x = randn(100,1);
% Running mean
y = Mean2(x);

If you are using a release prior to R2016b, replace Mean1(x) with step(Mean1,x) and Mean2(x) with step(Mean2,x).

Mean

x = randn(100,1);
y = mean(x);

Running Mean

mvgAvg = dsp.MovingAverage;
mvgAvg.SpecifyWindowLength = false;
x = randn(100,1);
y = mvgAvg(x);

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

See System Objects in MATLAB Code Generation (MATLAB Coder).

Documentation

dsp.Mean

Description

Note

Creation

Syntax

Description

Properties

RunningMean — Calculate over single input or multiple inputs false (default) | true

ResetInputPort — Additional input to enable resetting of running mean false (default) | true

Dependencies

ResetCondition — Condition that triggers resetting of running mean Non-zero (default) | Rising edge | Falling edge | Either edge

Dependencies

Dimension — Dimension to operate along Column (default) | All | Row | Custom

Dependencies

CustomDimension — Numerical dimension to calculate over 1 (default) | positive integer

Dependencies

Fixed-Point Properties

RoundingMethod — Rounding method for fixed-point operations Floor (default) | Ceiling | Convergent | Nearest | Round | Simplest | Zero

OverflowAction — Action to take when integer input is out of range Wrap (default) | Saturate

AccumulatorDataType — Data type of accumulator Same as input (default) | Custom

CustomAccumulatorDataType — Accumulator word and fraction lengths numerictype([],32,30) (default) | numerictype

Dependencies

OutputDataType — Data type of output Same as accumulator (default) | Same as input | Custom

CustomOutputDataType — Output word and fraction lengths numerictype([],32,30) (default) | numerictype

Dependencies

Usage

Syntax

Description

Input Arguments

x — Data input vector | matrix

r — Reset signal scalar

Dependencies

Output Arguments

y — Mean scalar | vector | matrix

Object Functions

Common to All System Objects

Examples

Compute Mean and Running Mean of Signal

Algorithms

Compatibility Considerations

dsp.Mean System object will be removed

Extended Capabilities

C/C++ Code Generation Generate C and C++ code using MATLAB® Coder™.

See Also

Functions

Objects

Blocks

Introduced in R2012a

DSP System Toolbox Documentation

Support

`RunningMean` — Calculate over single input or multiple inputs
`false` (default) | `true`

`ResetInputPort` — Additional input to enable resetting of running mean
`false` (default) | `true`

`ResetCondition` — Condition that triggers resetting of running mean
`Non-zero` (default) | `Rising edge` | `Falling edge` | `Either edge`

`Dimension` — Dimension to operate along
`Column` (default) | `All` | `Row` | `Custom`

`CustomDimension` — Numerical dimension to calculate over
`1` (default) | positive integer

`RoundingMethod` — Rounding method for fixed-point operations
`Floor` (default) | `Ceiling` | `Convergent` | `Nearest` | `Round` | `Simplest` | `Zero`

`OverflowAction` — Action to take when integer input is out of range
`Wrap` (default) | `Saturate`

`AccumulatorDataType` — Data type of accumulator
`Same as input` (default) | `Custom`

`CustomAccumulatorDataType` — Accumulator word and fraction lengths
`numerictype([],32,30)` (default) | numerictype

`OutputDataType` — Data type of output
`Same as accumulator` (default) | `Same as input` | `Custom`

`CustomOutputDataType` — Output word and fraction lengths
`numerictype([],32,30)` (default) | numerictype

`x` — Data input
vector | matrix

`r` — Reset signal
scalar

`y` — Mean
scalar | vector | matrix

`dsp.Mean` System object will be removed

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.