Notes

This is the inner function to peak_prominences .

Parameters

x : ndarray

A signal with peaks.

peaks : ndarray

Indices of peaks in x.

wlen : np.intp

A window length in samples (see peak_prominences ) which is rounded up to the nearest odd integer. If smaller than 2 the entire signal x is used.

Raises

ValueError

If a value in :None:None:`peaks` is an invalid index for x.

Returns

prominences : ndarray

The calculated prominences for each peak in :None:None:`peaks`.

left_bases, right_bases : ndarray

The peaks' bases as indices in x to the left and right of each peak.

Calculate the prominence of each peak in a signal.

Warns

PeakPropertyWarning

If a prominence of 0 was calculated for any peak.

Examples

See :

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 : None#None
type: <class 'builtin_function_or_method'>
Commit: