mindspore.dataset.audio.DetectPitchFrequency
============================================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/r2.3.q1/resource/_static/logo_source.svg
    :target: https://gitee.com/mindspore/mindspore/blob/r2.3.q1/docs/api/api_python/dataset_audio/mindspore.dataset.audio.DetectPitchFrequency.rst
    :alt: 查看源文件


.. py:class:: mindspore.dataset.audio.DetectPitchFrequency(sample_rate, frame_time=0.01, win_length=30, freq_low=85, freq_high=3400)

    检测音调频率。
    基于归一化互相关函数和中位平滑来实现。

    参数：
        - **sample_rate** (int) - 波形的采样频率，如44100 (单位：Hz)，值不能为0。
        - **frame_time** (float, 可选) - 帧的持续时间，值必须大于零。默认值： ``0.01`` 。
        - **win_length** (int, 可选) - 中位平滑的窗口长度（以帧数为单位），该值必须大于零。默认值： ``30`` 。
        - **freq_low** (int, 可选) - 可检测的最低频率（Hz），该值必须大于零。默认值： ``85`` 。
        - **freq_high** (int, 可选) - 可检测的最高频率（Hz），该值必须大于零。默认值： ``3400`` 。

    异常：
        - **TypeError** - 如果 `sample_rate` 不是int类型。
        - **ValueError** - 如果 `sample_rate` 为0。
        - **TypeError** - 如果 `frame_time` 不是float类型。
        - **ValueError** - 如果 `frame_time` 不为正数。
        - **TypeError** - 如果 `win_length` 不是int类型。
        - **ValueError** - 如果 `win_length` 不为正数。
        - **TypeError** - 如果 `freq_low` 不是int类型。
        - **ValueError** - 如果 `freq_low` 不为正数。
        - **TypeError** - 如果 `freq_high` 不是int类型。
        - **ValueError** - 如果 `freq_high` 不为正数。

    教程样例：
        - `音频变换样例库
          <https://www.mindspore.cn/docs/zh-CN/r2.3.0rc1/api_python/samples/dataset/audio_gallery.html>`_