mindspore.dataset.audio.FrequencyMasking
========================================

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


.. py:class:: mindspore.dataset.audio.FrequencyMasking(iid_masks=False, freq_mask_param=0, mask_start=0, mask_value=0.0)

    给音频波形施加频域掩码。

    .. note:: 待处理音频shape需为<..., freq, time>。

    参数：
        - **iid_masks** (bool, 可选) - 是否施加随机掩码。默认值： ``False`` 。
        - **freq_mask_param** (int, 可选) - 当 `iid_masks` 为 ``True`` 时，掩码长度将从[0, freq_mask_param]中均匀采样；当 `iid_masks` 为 ``False`` 时，直接使用该值作为掩码长度。取值范围为[0, freq_length]，其中 `freq_length` 为音频波形在频域的长度。默认值： ``0`` 。
        - **mask_start** (int, 可选) - 添加掩码的起始位置，只有当 `iid_masks` 为 ``True`` 时，该值才会生效。取值范围为[0, freq_length - frequency_mask_param]，其中 `freq_length` 为音频波形在频域的长度。默认值： ``0`` 。
        - **mask_value** (float, 可选) - 掩码填充值。默认值： ``0.0`` 。

    异常：
        - **TypeError** - 当 `iid_masks` 的类型不为bool。
        - **TypeError** - 当 `freq_mask_param` 的类型不为int。
        - **ValueError** - 当 `freq_mask_param` 大于音频频域长度。
        - **TypeError** - 当 `mask_start` 的类型不为int。
        - **ValueError** - 当 `mask_start` 为负数。
        - **TypeError** - 当 `mask_value` 的类型不为float。
        - **ValueError** - 当 `mask_value` 为负数。
        - **RuntimeError** - 当输入音频的shape不为<..., freq, time>。

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

    .. image:: frequency_masking_original.png

    .. image:: frequency_masking.png