dsp.Mean

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 Running mode in the dsp.Mean System object™ will be removed in a future release. To compute the running mean in MATLAB®, use the dsp.MovingAverage System object instead.

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

  1. Create the dsp.Mean object and set its properties.

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

example

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

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.

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.

Specify the event that resets the running maximum.

Dependencies

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

Specify how the mean calculation is performed over the data.

Dependencies

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

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.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Fixed-Point Properties

Specify the rounding method.

Specify the overflow action.

Specify the accumulator fixed-point data type.

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.

Specify the output fixed-point data type.

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

For versions earlier than R2016b, use the step function to run the System object algorithm. The arguments to step are the object you created, followed by the arguments shown in this section.

For example, y = step(obj,x) and y = obj(x) perform equivalent operations.

Syntax

y = mn(x)
y = mn(x,r)

Description

example

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

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.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fi
Complex Number Support: Yes

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.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

Output Arguments

expand all

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.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | fi
Complex Number Support: Yes

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

stepRun System object algorithm
releaseRelease resources and allow changes to System object property values and input characteristics
resetReset internal states of System object

Examples

expand all

Note: This example runs only in R2016b or later. If you are using an earlier release, replace each call to the function with the equivalent step syntax. For example, myObject(x) becomes step(myObject,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.

Extended Capabilities

See Also

System Objects

Blocks

Introduced in R2012a