Function analysis

pyroomacoustics/transform/stft.py:734–775

Convenience function for one-shot STFT Parameters ---------- x: array_like, (n_samples) or (n_samples, n_channels) input signal L: int frame size hop: int shift size between frames win: array_like the window to apply (default None) zp

(x, L, hop, win=None, zp_back=0, zp_front=0)

def analysis(x, L, hop, win=None, zp_back=0, zp_front=0):
    """
    Convenience function for one-shot STFT

    Parameters
    ----------
    x: array_like, (n_samples) or (n_samples, n_channels)
        input signal
    L: int
        frame size
    hop: int
        shift size between frames
    win: array_like
        the window to apply (default None)
    zp_back: int
        zero padding to apply at the end of the frame
    zp_front: int
        zero padding to apply at the beginning of the frame

    Returns
    -------
    X: ndarray, (n_frames, n_frequencies) or (n_frames, n_frequencies, n_channels)
        The STFT of x
    """

    if x.ndim == 2:
        channels = x.shape[1]
    else:
        channels = 1

    the_stft = STFT(
        L, hop=hop, analysis_window=win, channels=channels, precision=x.dtype
    )

    if zp_back > 0:
        the_stft.zero_pad_back(zp_back)

    if zp_front > 0:
        the_stft.zero_pad_front(zp_front)

    # apply transform
    return the_stft.analysis(x)


# inverse STFT