Documentation

dsp.Minimum System object

Package: dsp

Find minimum values of input or sequence of inputs

Description

The Minimum object finds the minimum value of an input or sequence of inputs.

To compute the minimum value of an input or sequence of inputs:

  1. Define and set up your System object™. See Construction.

  2. Call step to compute the minimum according to the properties of dsp.Minimum. The behavior of step is specific to each object in the toolbox.

Construction

H = dsp.Minimum returns an object, H, that computes the value and/or index of the minimum elements in an input or a sequence of inputs over the specified Dimension.

H = dsp.Minimum('PropertyName',PropertyValue,...) returns a minimum-finding object, H, with each specified property set to the specified value.

Properties

ValueOutputPort

Output minimum value

Set this property to true in order to output the minimum value of the input. This property applies only when you set the RunningMinimum property to false. The default is true.

RunningMinimum

Calculate over single input or multiple inputs

When you set this property to true, the object computes the minimum value over successive calls to the step method. When you set this property to false, the object computes the minimum value over the current input. The default is false.

IndexOutputPort

Output index of minimum value

Set this property to true to output the index of the minimum value of the input. This property applies only when you set the RunningMinimum property to false. The default is true.

ResetInputPort

Additional input to enable resetting of running minimum

Set this property to true to enable resetting of the running minimum. When you set this property to true, you must specify a reset input to the step method to reset the running minimum. This property applies only when you set the RunningMinimum property to true. The default is false.

ResetCondition

Condition that triggers resetting of running minimum

Specify the event that resets the running minimum as one of | Rising edge | Falling edge | Either edge | Non-zero |. This property applies only when you set the ResetInputPort property to true. The default is Non-zero.

IndexBase

Numbering base for index of minimum value

Specify the numbering used when computing the index of the minimum value as starting from either One or Zero. This property applies only when you set the IndexOutputPort property to true. The default is One.

Dimension

Dimension to operate along

Specify how the minimum calculation is performed over the data as one of | All | Row | Column | Custom |. This property applies when you set the RunningMinimum property to false. The default is Column.

CustomDimension

Numerical dimension to calculate over

Specify the integer dimension of the input signal over which the object finds the minimum. The cannot exceed the number of dimensions in the input signal. This property only applies when you set the Dimension property to Custom. The default is 1.

 Fixed-Point Properties

Methods

cloneCreate minimum-finding object with same property values
getNumInputsNumber of expected inputs to step method
getNumOutputsNumber of outputs of step method
isLockedLocked status for input attributes and nontunable properties
releaseAllow property value and input characteristics changes
resetReset internal states of minimum-finding object
stepOperate on inputs to calculate outputs

Examples

Find a minimum value and its index:

 hmin1 = dsp.Minimum;
 x = randn(100,1);
 [y, I] = step(hmin1, x);

Compute a running minimum:

 hmin2 = dsp.Minimum;
 hmin2.RunningMinimum = true;
 x = randn(100,1);
 y = step(hmin2, x); 
 % y(i) is the minimum of all values in the vector x(1:i)

Algorithms

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

Introduced in R2012a

Was this topic helpful?