Find maximum value of input or sequence of inputs
The dsp.Maximum
object finds the maximum values
of an input or sequence of inputs.
To compute the maximum value of an input or sequence of inputs:
Define and set up your System object™. See Construction.
Call step
to find the maximum according to the
properties of dsp.Maximum
. The behavior of step
is
specific to each object in the toolbox.
Starting in R2016b, instead of using the step
method
to perform the operation defined by the System
object, you can
call the object with arguments, as if it were a function. For example, y
= step(obj,x)
and y = obj(x)
perform
equivalent operations.
The Running
mode in the dsp.Maximum
System
object will
be removed in a future release. To compute the running maximum in MATLAB^{®},
use the dsp.MovingMaximum
System
object instead.
max = dsp.Maximum
returns an object, max
, that
computes the value and index of the maximum elements in an input or a sequence of inputs
along the specified Dimension.
max = dsp.Maximum('
returns
a maximumfinding object, PropertyName
',PropertyValue
,...)max
, with each specified
property set to the specified value.

Output maximum value Set this property to 

Calculate over single input or multiple inputs When you set this property to 

Output index of maximum value Set this property to 

Additional input to enable resetting of running maximum Set this property to 

Condition that triggers resetting of running maximum Specify the event that resets the running maximum as one of  

Numbering base for index of maximum value Specify whether to start the index numbering from 

Dimension to operate along Specify how the maximum calculation is performed over the data as one of 


Numerical dimension to calculate over Specify the integer dimension of the input signal over which the object finds the maximum. The
cannot exceed the number of dimensions in the input signal. This property
only applies when you set the Dimension property to

reset  Reset computation of running maximum 
step  Maximum value 
Common to All System Objects  

clone  Create System object with same property values 
getNumInputs  Expected number of inputs to a System object 
getNumOutputs  Expected number of outputs of a System object 
isLocked  Check locked states of a System object (logical) 
release  Allow System object property value changes 
This object implements the algorithm, inputs, and outputs described on the Maximum block reference page. The object properties correspond to the block parameters.