tf.image.non_max_suppression
Stay organized with collections
Save and categorize content based on your preferences.
Greedily selects a subset of bounding boxes in descending order of score.
tf.image.non_max_suppression(
boxes, scores, max_output_size, iou_threshold=0.5,
score_threshold=float('-inf'), name=None
)
Prunes away boxes that have high intersection-over-union (IOU) overlap
with previously selected boxes. Bounding boxes are supplied as
[y1, x1, y2, x2]
, where (y1, x1)
and (y2, x2)
are the coordinates of any
diagonal pair of box corners and the coordinates can be provided as normalized
(i.e., lying in the interval [0, 1]
) or absolute. Note that this algorithm
is agnostic to where the origin is in the coordinate system. Note that this
algorithm is invariant to orthogonal transformations and translations
of the coordinate system; thus translating or reflections of the coordinate
system result in the same boxes being selected by the algorithm.
The output of this operation is a set of integers indexing into the input
collection of bounding boxes representing the selected boxes. The bounding
box coordinates corresponding to the selected indices can then be obtained
using the tf.gather
operation. For example:
selected_indices = tf.image.non_max_suppression(
boxes, scores, max_output_size, iou_threshold)
selected_boxes = tf.gather(boxes, selected_indices)
Args |
boxes
|
A 2-D float Tensor of shape [num_boxes, 4] .
|
scores
|
A 1-D float Tensor of shape [num_boxes] representing a single
score corresponding to each box (each row of boxes).
|
max_output_size
|
A scalar integer Tensor representing the maximum number
of boxes to be selected by non max suppression.
|
iou_threshold
|
A float representing the threshold for deciding whether boxes
overlap too much with respect to IOU.
|
score_threshold
|
A float representing the threshold for deciding when to
remove boxes based on score.
|
name
|
A name for the operation (optional).
|
Returns |
selected_indices
|
A 1-D integer Tensor of shape [M] representing the
selected indices from the boxes tensor, where M <= max_output_size .
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-10-01 UTC.
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.image.non_max_suppression\n\n\u003cbr /\u003e\n\n|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| [TensorFlow 1 version](/versions/r1.15/api_docs/python/tf/image/non_max_suppression) | [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.0.0/tensorflow/python/ops/image_ops_impl.py#L2604-L2653) |\n\nGreedily selects a subset of bounding boxes in descending order of score.\n\n#### View aliases\n\n\n**Compat aliases for migration**\n\nSee\n[Migration guide](https://www.tensorflow.org/guide/migrate) for\nmore details.\n\n[`tf.compat.v1.image.non_max_suppression`](/api_docs/python/tf/image/non_max_suppression)\n\n\u003cbr /\u003e\n\n tf.image.non_max_suppression(\n boxes, scores, max_output_size, iou_threshold=0.5,\n score_threshold=float('-inf'), name=None\n )\n\nPrunes away boxes that have high intersection-over-union (IOU) overlap\nwith previously selected boxes. Bounding boxes are supplied as\n`[y1, x1, y2, x2]`, where `(y1, x1)` and `(y2, x2)` are the coordinates of any\ndiagonal pair of box corners and the coordinates can be provided as normalized\n(i.e., lying in the interval `[0, 1]`) or absolute. Note that this algorithm\nis agnostic to where the origin is in the coordinate system. Note that this\nalgorithm is invariant to orthogonal transformations and translations\nof the coordinate system; thus translating or reflections of the coordinate\nsystem result in the same boxes being selected by the algorithm.\nThe output of this operation is a set of integers indexing into the input\ncollection of bounding boxes representing the selected boxes. The bounding\nbox coordinates corresponding to the selected indices can then be obtained\nusing the [`tf.gather`](../../tf/gather) operation. For example:\n\u003e\n\u003e selected_indices = tf.image.non_max_suppression(\n\u003e boxes, scores, max_output_size, iou_threshold)\n\u003e selected_boxes = tf.gather(boxes, selected_indices)\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|-------------------|------------------------------------------------------------------------------------------------------------------------|\n| `boxes` | A 2-D float `Tensor` of shape `[num_boxes, 4]`. |\n| `scores` | A 1-D float `Tensor` of shape `[num_boxes]` representing a single score corresponding to each box (each row of boxes). |\n| `max_output_size` | A scalar integer `Tensor` representing the maximum number of boxes to be selected by non max suppression. |\n| `iou_threshold` | A float representing the threshold for deciding whether boxes overlap too much with respect to IOU. |\n| `score_threshold` | A float representing the threshold for deciding when to remove boxes based on score. |\n| `name` | A name for the operation (optional). |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|--------------------|------------------------------------------------------------------------------------------------------------------------------|\n| `selected_indices` | A 1-D integer `Tensor` of shape `[M]` representing the selected indices from the boxes tensor, where `M \u003c= max_output_size`. |\n\n\u003cbr /\u003e"]]