bundles / scipy 1.18.0 / scipy / signal / _peak_finding / _unpack_condition_args

function

`scipy.signal._peak_finding:_unpack_condition_args`

source: /scipy/signal/_peak_finding.py:596

Signature

def _unpack_condition_args(interval, x, peaks)

Summary

Parse condition arguments for find_peaks.

Parameters

interval : number or ndarray or sequence: Either a number or ndarray or a 2-element sequence of the former. The first value is always interpreted as imin and the second, if supplied, as imax.
x : ndarray: The signal with peaks.
peaks : ndarray: An array with indices used to reduce imin and / or imax if those are arrays.

Returns

imin, imax : number or ndarray or None: Minimal and maximal value in argument.

Raises

: ValueError: If interval border is given as array and its size does not match the size of x.

Notes

Aliases

scipy.signal._peak_finding._unpack_condition_args