scipy 1.8.0 Pypi GitHub Homepage
Other Docs
NotesParametersReturnsBackRef
argrelmax(data, axis=0, order=1, mode='clip')

Notes

This function uses argrelextrema with np.greater as comparator. Therefore, it requires a strict inequality on both sides of a value to consider it a maximum. This means flat maxima (more than one sample wide) are not detected. In case of 1-D data find_peaks can be used to detect all local maxima, including flat ones.

versionadded

Parameters

data : ndarray

Array in which to find the relative maxima.

axis : int, optional

Axis over which to select from data . Default is 0.

order : int, optional

How many points on each side to use for the comparison to consider comparator(n, n+x) to be True.

mode : str, optional

How the edges of the vector are treated. Available options are 'wrap' (wrap around) or 'clip' (treat overflow as the same as the last (or first) element). Default 'clip'. See numpy.take .

Returns

extrema : tuple of ndarrays

Indices of the maxima in arrays of integers. extrema[k] is the array of indices of axis :None:None:`k` of data . Note that the return value is a tuple even when data is 1-D.

Calculate the relative maxima of data .

See Also

argrelextrema
argrelmin
find_peaks

Examples

>>> from scipy.signal import argrelmax
... x = np.array([2, 1, 2, 3, 2, 0, 1, 0])
... argrelmax(x) (array([3, 6]),)
>>> y = np.array([[1, 2, 1, 2],
...  [2, 2, 0, 0],
...  [5, 3, 4, 4]]) ...
>>> argrelmax(y, axis=1)
(array([0]), array([1]))
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

scipy.signal._peak_finding._boolrelextrema scipy.signal._peak_finding_utils._local_maxima_1d scipy.signal._peak_finding.argrelmax scipy.signal._peak_finding.argrelmin scipy.signal._peak_finding.argrelextrema

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


GitHub : /scipy/signal/_peak_finding.py#138
type: <class 'function'>
Commit: