Estimators
==============

.. currentmodule:: pyvoimooo

.. function:: voicing(in, fs)

    Estimate the voicing of an input speech signal.

    :arg in: The input wavform to extract the frames from.
    :type in: array<float>

    :arg fs: The sampling rate.
    :type fs: int, Hz

    :return:

        - **tss** (`float`,second) - Time instants of analysis (the center time of each frame)

        - **voicings** (`array<float>`,[0.0,1.0]).


.. function:: level(in, fs, [useloudness], [voicedonly])

    Estimate the level of the voice in the speech signal.

    :arg in: The input wavform to extract the frames from.
    :type in: array<float>

    :arg fs: The sampling rate.
    :type fs: int, Hz

    :arg useloudness: Weight the spectrum according to perceived loudness (def. true).
    :type useloudness: boolean, optional

    :arg voicedonly: Compute the level only from voiced segments (def. true). Setting it to `false` will compute the level from whole signal.
    :type voicedonly: boolean, optional

    :return:

        - **lvl** (`float`,[dB]) - The estimated level.

    .. versionadded:: 0.17.14


.. function:: normalise(in, fs, rqlvl)

    Normalise the given waveform to a given level :attr:`rqlvl` using :func:`level` function.

    :arg in: The input waveform to transform.
    :type in: array<float>

    :arg fs: The sampling rate.
    :type fs: int, Hz

    :arg rqlvl: The requested voice level.
    :type rqlvl: float, dB

    :return:

        - **syn** (`array<float>`) - The normalised waveform.

    .. versionadded:: 0.17.14