mindspore.ops.BoundingBoxEncode
================================

.. 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/ops/mindspore.ops.BoundingBoxEncode.rst
    :alt: 查看源文件


.. py:class:: mindspore.ops.BoundingBoxEncode(means=(0.0, 0.0, 0.0, 0.0), stds=(1.0, 1.0, 1.0, 1.0))

    编码边界框位置信息。

    算子的功能是计算预测边界框和真实边界框之间的偏移，并将此偏移作为损失变量。

    参数：
        - **means** (tuple) - 计算编码边界框的均值。默认值： ``(0.0, 0.0, 0.0, 0.0)`` 。
        - **stds** (tuple) - 计算增量的标准偏差。默认值： ``(1.0, 1.0, 1.0, 1.0)`` 。

    输入：
        - **anchor_box** (Tensor) - 锚框。锚框的shape必须为 :math:`(n, 4)` 。
        - **groundtruth_box** (Tensor) - 真实边界框。它的shape与锚框相同。

    输出：
        Tensor，编码边界框。数据类型和shape与输入 `anchor_box` 相同。

    异常：
        - **TypeError** - 如果 `means` 或 `stds` 不是tuple。
        - **TypeError** - 如果 `anchor_box` 或 `groundtruth_box` 不是Tensor。