Windows
=======

.. currentmodule:: pyvoimooo


.. function:: compute_bandwidth_6dB_below_max(win)

    :arg win: An array containing the samples of a window function.

    :return: The bandwidth [0.,0.5] of the window, 6dB below its max value. (not the half bandwith !) [the unit is normalized with respect to the sampling rate, i.e. You can multiply by :math:`f_s` to get the bandwith in Hz].

    .. versionadded:: 0.8.9

.. function:: compute_sidelobes_level(win)

    :arg win: An array containing the samples of a window function.

    :return: The level of the side-lobes from the max value.

    .. versionadded:: 0.8.9


.. function:: compute_parabolic_logfit_a(win)

    :arg win: An array containing the samples of a window function.

    :return: The `A` quadratic coefficent of the parabolic fitting of the summit of the window [unitless].

    .. versionadded:: 0.8.9


.. function:: rectangular(n)

    Generate a rectangular window.

    :arg n: The length of the window.

    .. versionadded:: 0.8.9


.. function:: gencoswindow(n, c)

    Generate a `cosine window <https://en.wikipedia.org/wiki/Window_function#Cosine-sum_windows>`_ given coefficients.

    :arg n: The length of the window.

    :arg c: The coefficients parametrizing the cosine window.

    .. versionadded:: 0.8.9

.. function:: hann(n)

    Generate a Hann window.

    :arg n: The length of the window.

    .. versionadded:: 0.8.9

.. function:: hamming(n)

    Generate a Hamming window.

    :arg n: The length of the window.

    .. versionadded:: 0.8.9

.. function:: blackman(n)

    Generate a Blackman window.

    :arg n: The length of the window.

    .. versionadded:: 0.8.9

.. function:: nutall(n)

    Generate a Nutall window.

    :arg n: The length of the window.

    .. versionadded:: 0.8.9

.. function:: blackmannutall(n)

    Generate a Blackman-Nutall window.

    :arg n: The length of the window.

    .. versionadded:: 0.8.9

.. function:: blackmanharris(n)

    Generate a Blackman-Harris window.

    :arg n: The length of the window.

    .. versionadded:: 0.8.9

.. function:: flattop(n)

    Generate a Flattop window.

    :arg n: The length of the window.

    .. versionadded:: 0.8.9


.. function:: genexpwindow(n, sigma, p)

    Generate an `generalized exponential window <https://en.wikipedia.org/wiki/Window_function#Generalized_normal_window>`_.

    :arg n: The length of the window.

    :arg sigma: The standard-deviation coefficient.

    :arg p: The power coefficient.

    .. versionadded:: 0.8.9

.. function:: normwindow(n, std)

    Generate a Normal (Gaussian) window.

    :arg n: The length of the window.

    :arg std: The standard-deviation coefficient.

    .. versionadded:: 0.8.9

.. function:: expwindow(n, D)

    Generate an `exponential window <https://en.wikipedia.org/wiki/Window_function#Exponential_or_Poisson_window>`_.

    :arg n: The length of the window.

    :arg D: The D coefficient.

    .. versionadded:: 0.8.9

.. function:: kaiser(n, D)

    Generate a `Kaiser window <https://en.wikipedia.org/wiki/Window_function#Kaiser_window>`_.

    :arg n: The length of the window.

    :arg D: The D coefficient.

    .. versionadded:: 0.8.9