{ } Raw JSON

bundles / scipy 1.17.1 / scipy / signal / _spectral_py / _triage_segments

function

scipy.signal._spectral_py:_triage_segments

source: /scipy/signal/_spectral_py.py :2400

Signature

def   _triage_segments ( window nperseg input_length )

Summary

Parses window and nperseg arguments for spectrogram and _spectral_helper. This is a helper function, not meant to be called externally.

Parameters

window : string, tuple, or ndarray

If window is specified by a string or tuple and nperseg is not specified, nperseg is set to the default of 256 and returns a window of that length. If instead the window is array_like and nperseg is not specified, then nperseg is set to the length of the window. A ValueError is raised if the user supplies both an array_like window and a value for nperseg but nperseg does not equal the length of the window.

nperseg : int

Length of each segment

input_length: int

Length of input signal, i.e. x.shape[-1]. Used to test for errors.

Returns

win : ndarray

window. If function was called with string or tuple than this will hold the actual array used as a window.

nperseg : int

Length of each segment. If window is str or tuple, nperseg is set to 256. If window is array_like, nperseg is set to the length of the window.

Aliases

  • scipy.signal._spectral_py._triage_segments