Maximum (DSP Blockset)

Find the maximum value of an input or sequence of inputs.

Library

Statistics, in Math Functions

Description

The Maximum block identifies the value and position of the largest element in the input, or tracks the maximum value in a sequence of inputs over a period of time. The Mode parameter specifies the block's mode of operation and can be set to Value, Index, Value and Index, or Running. These settings are described below.

Value

When Mode is set to Value, the block computes the maximum value of the input vector.

[y,i] = max(u(:))        % equivalent MATLAB code

The block output, y, is the maximum value of the input at each sample time. For complex inputs the block uses the magnitude of the input, abs(u(:)), to identify the maximum. The output is the corresponding complex value from the input.

Index

When Mode is set to Index, the block performs the computation shown above, and outputs the index, i, corresponding to the position of the maximum value in the input vector. The index is an integer in the range [1 length(u(:))].

If there are duplicates of the maximum value in the input, the index corresponds to the first occurrence. For example, if the vector input is [3 2 1 2 3], the index of the maximum value is 1, not 5.

Value and Index

When Mode is set to Value and Index, the block outputs both the value, y, and the index, i.

In all three of the above modes, a matrix input, u, is treated as a vector, u(:).

Running

When Mode is set to Running, the block tracks the maximum value in a sequence of inputs over time. You can choose frame-based or sample-based operation by selecting or deselecting the Frame-based check box.

Sample-Based Operation. When the Frame-based check box is not selected (default), the block assumes that the input at the In port is a 1-by-N sample vector or M-by-N sample matrix. Each of the N vector elements (or M*N matrix elements) is treated as an independent channel, and the block tracks the maximum value in each of the channels over time.

The block resets the running maximum when the scalar input at the optional Rst port is nonzero. The output is the same size as the input, and contains the maximum for each input channel since the last reset.

If you do not need to reset the running maximum during the simulation, you can delete the Rst port from the block icon by deselecting the Reset port check box.

Frame-Based Operation. When the Frame-based check box is selected, the block assumes that the input at the In port is an M-by-N frame matrix. Each of the N frames in the matrix contains M sequential time samples from an independent signal. The Number of channels parameter specifies the number of independent signals, N, in the matrix.

The block tracks the maximum value in each of the N independent channels over time, and resets the running maximum when the input at the Rst port is nonzero. The output is a sample vector of length N which contains the maximum for each input channel since the last reset.

Note
If you expect to generate code for the Maximum block's running mode using the Real-Time Workshop, you should ensure that inputs are contiguous in memory. See the Contiguous Copy block for more information.

Dialog Box

Mode: The block's mode of operation: Output the maximum value of each input, the index of the maximum value, both the value and the index, or track the maximum value of the input sequence over time.
Reset port: Enable Rst input port.
Frame-based: Selects frame-based operation.
Number of channels: For frame based operation, the number of channels (columns) in the input matrix, N.