docs/api/api_python/ops/mindspore.ops.func_fft2.rst - master - envoy.istio/mindspore

docs/api/api_python/ops/mindspore.ops.func_fft2.rst

39 строк2 KB

z00841464

add fft/ifft/fft2/ifft2/fftn/ifftn docs

11 мар 2024, 11:22

11 мар 2024, 11:229a35112

mindspore.ops.fft2
=================================

.. py:function:: mindspore.ops.fft2(input, s=None, dim=(-2,-1), norm=None)

    计算输入的二维快速傅里叶变换。

    .. note::
        - `fft2` 目前仅用于 `mindscience` 科学计算场景，尚不支持其他使用场景。
        - `fft2` 尚不支持Windows平台。

    参数：
        - **input** (Tensor) - 输入的Tensor。支持数据类型：

          - Ascend/CPU： int16、int32、int64、float16、float32、float64、complex64、complex128。

        - **s** (tuple[int], 可选) - 信号长度。如果给定，则在计算 `fft2` 之前 `dim[i]` 轴的大小将被零填充或截断至 `s[i]`。
          默认值： ``None`` , 表示无需对 `input` 进行处理。
        - **dim** (tuple[int], 可选) - 指定进行 `fft2` 的维度。默认值： ``(-2,-1)`` ，表示对 `input` 的最后两个维度进行变换。
        - **norm** (str, 可选) - 标准化模式。默认值： ``None`` ，采用 ``'backward'`` 。
          三种模式定义为：

          - ``'backward'`` 表示不进行标准化。
          - ``'forward'`` 表示按 :math:`1/n` 标准化。
          - ``'ortho'`` 表示按 :math:`1/\sqrt{n}` 标准化。

    返回： 
        Tensor，二维快速傅里叶变换的结果。默认与 `input` 同shape，如果给定 `s`，则 `dim[i]` 轴的大小改为 `s[i]` 。
        当输入为 int16、int32、int64、float16、float32、complex64 时，返回值类型为complex64。
        当输入为 float64、complex128 时，返回值类型为complex128。

    异常：
        - **TypeError** - 如果 `input` 不是Tensor。
        - **TypeError** - 如果 `input` 数据类型不是其中之一: int32、int64、float32、float64、complex64、complex128。
        - **TypeError** - 如果 `dim` 和 `s` 不是tuple[int]类型。
        - **ValueError** - 如果 `dim` 中存在超出： :math:`[-input.ndim, input.ndim)` 范围的值。
        - **ValueError** - 如果 `dim` 中存在重复值。
        - **ValueError** - 如果 `s` 中存在小于1的值。
        - **ValueError** - 如果 `norm` 的值不是 ``'backward'`` 、 ``'forward'`` 或 ``'ortho'`` 。