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

mindspore.ops.NonMaxSuppressionWithOverlaps
============================================

.. py:class:: mindspore.ops.NonMaxSuppressionWithOverlaps

    按照得分从高到低贪心地选择一组边界框，同时移除与之前选定的边界框高度重叠的边界框
    得分低于 `score_threshold` 的边界框将被删除。可以定义自定义重叠标准（例如，IoU，IoA等），重叠值以N-by-N矩阵形式提供。

    .. note::
        - 此算法与原点在坐标系中的位置无关。
        - 对于坐标系的正交变换和平移，该算法不受影响，因此坐标系的平移变换后算法会选择相同的框。

    输入：
        - **overlaps** (Tensor) - 二维Tensor，其shape为 :math:`(num\_boxes, num\_boxes)` ，表示n乘n的边框重叠值。支持的数据类型为float16、float32和float64。
        - **scores** (Tensor) - 一个shape为 :math:`(num\_boxes)` 的一维Tensor，表示每个边框（也就是 `boxes` Tensor的每一行）对应的单个分数。 `scores` 中的分数数量必须与 `boxes` 中的边框的数量相等。支持的数据类型为float32。
        - **max_output_size** (Union[Tensor, Number.Int]) - 选取最大的边框数，必须大于等于0，数据类型为int32。
        - **overlap_threshold** (Union[Tensor, Number.Float]) - 边框重叠值阈值，重叠值大于此值说明重叠过大。支持的数据类型为float16、float32和float64。
        - **score_threshold** (Union[Tensor, Number.Float]) - 移除边框阈值，边框score值大于此值则移除相应边框。数据类型与 `overlap_threshold` 一致。

    输出：
        一维Tensor，表示被选中边框的index，其shape为 :math:`(M)` ，其中M <= `max_output_size` 。数据类型为int32。

    异常：
        - **TypeError** - `overlaps` 、 `scores` 、 `overlap_threshold` 和 `score_threshold` 的数据类型不是float16、float32或float64。
        - **TypeError** - `overlaps` 或者 `scores` 不是Tesnor。
        - **TypeError** - `max_output_size` 不是Tesnor或者Scalar，或者其数据类型不是int32。
        - **TypeError** - `overlap_threshold` 不是Tesnor或者Scalar，或者其数据类型不是float16、float32或float64。
        - **TypeError** - `score_threshold` 不是Tesnor或者Scalar，或者其数据类型不是float16、float32或float64。
        - **ValueError** - `overlaps` 长度不等于2或者其shape的两个值不相等。
        - **ValueError** - `scores` 的shape长度不是1。
        - **ValueError** - `max_output_size` 、 `overlap_threshold` 或者 `score_threshold` 的shape长度不是1。
        - **ValueError** - `max_output_size` 小于零。
        - **ValueError** - `scores` shape的大小与 `overlaps` 的第零或第一维不相等。