Main Content

Moving maximum

`M = movmax(`

returns
an array of local `A`

,`k`

)`k`

-point maximum values, where
each maximum is calculated over a sliding window of length `k`

across
neighboring elements of `A`

. When `k`

is
odd, the window is centered about the element in the current position.
When `k`

is even, the window is centered about the
current and previous elements. The window size is automatically truncated
at the endpoints when there are not enough elements to fill the window.
When the window is truncated, the maximum is taken over only the elements
that fill the window. `M`

is the same size as `A`

.

If

`A`

is a vector, then`movmax`

operates along the length of the vector.If

`A`

is a multidimensional array, then`movmax`

operates along the first array dimension whose size does not equal 1.

`M = movmax(___,`

returns
the array of moving maximums along dimension `dim`

)`dim`

for
any of the previous syntaxes. For example, if `A`

is
a matrix, then `movmax(A,k,2)`

operates along the
columns of `A`

, computing the `k`

-element
sliding maximum for each row.

`M = movmax(___,`

specifies
whether to include or omit `nanflag`

)`NaN`

values from the
calculation for any of the previous syntaxes. `movmax(A,k,'includenan')`

includes
all `NaN`

values in the calculation while `movmax(A,k,'omitnan')`

ignores
them and computes the maximum over fewer points.

`M = movmax(___,`

specifies
additional parameters for the moving maximum using one or more name-value
pair arguments. For example, if `Name,Value`

)`x`

is a vector of
time values, then `movmax(A,k,'SamplePoints',x)`

computes
the moving maximum relative to the times in `x`

.