nvinfer1::INMSLayer Class Reference

A non-maximum suppression layer in a network definition. More...

#include <NvInfer.h>

Inheritance diagram for nvinfer1::INMSLayer:

Public Member Functions
void	setBoundingBoxFormat (BoundingBoxFormat fmt) noexcept
	Set the bounding box format parameter for the layer. More...
BoundingBoxFormat	getBoundingBoxFormat () const noexcept
	Get the bounding box format parameter for the layer. More...
void	setTopKBoxLimit (int32_t limit) noexcept
	Set the TopK box limit parameter for the layer. More...
int32_t	getTopKBoxLimit () const noexcept
	Get the TopK box limit parameter for the layer. More...
void	setInput (int32_t index, ITensor &tensor) noexcept
	Append or replace an input of this layer with a specific tensor. More...
Public Member Functions inherited from nvinfer1::ILayer
LayerType	getType () const noexcept
	Return the type of a layer. More...
void	setName (char const *name) noexcept
	Set the name of a layer. More...
char const *	getName () const noexcept
	Return the name of a layer. More...
int32_t	getNbInputs () const noexcept
	Get the number of inputs of a layer. More...
ITensor *	getInput (int32_t index) const noexcept
	Get the layer input corresponding to the given index. More...
int32_t	getNbOutputs () const noexcept
	Get the number of outputs of a layer. More...
ITensor *	getOutput (int32_t index) const noexcept
	Get the layer output corresponding to the given index. More...
void	setInput (int32_t index, ITensor &tensor) noexcept
	Replace an input of this layer with a specific tensor. More...
void	setPrecision (DataType dataType) noexcept
	Set the computational precision of this layer. More...
DataType	getPrecision () const noexcept
	get the computational precision of this layer More...
bool	precisionIsSet () const noexcept
	whether the computational precision has been set for this layer More...
void	resetPrecision () noexcept
	reset the computational precision for this layer More...
void	setOutputType (int32_t index, DataType dataType) noexcept
	Set the output type of this layer. More...
DataType	getOutputType (int32_t index) const noexcept
	get the output type of this layer More...
bool	outputTypeIsSet (int32_t index) const noexcept
	whether the output type has been set for this layer More...
void	resetOutputType (int32_t index) noexcept
	reset the output type for this layer More...
void	setMetadata (char const *metadata) noexcept
	Set the metadata for this layer. More...
char const *	getMetadata () const noexcept
	Get the metadata of the layer. More...

Protected Member Functions
virtual	~INMSLayer () noexcept=default
Protected Member Functions inherited from nvinfer1::ILayer
virtual	~ILayer () noexcept=default
Protected Member Functions inherited from nvinfer1::INoCopy
	INoCopy ()=default
virtual	~INoCopy ()=default
	INoCopy (INoCopy const &other)=delete
INoCopy &	operator= (INoCopy const &other)=delete
	INoCopy (INoCopy &&other)=delete
INoCopy &	operator= (INoCopy &&other)=delete

Protected Attributes
apiv::VNMSLayer *	mImpl
Protected Attributes inherited from nvinfer1::ILayer
apiv::VLayer *	mLayer

Detailed Description

A non-maximum suppression layer in a network definition.

The NMS algorithm iterates through a set of bounding boxes and their confidence scores, in decreasing order of score. Boxes are selected if their score is above a given threshold, and their intersection-over-union (IoU) with previously selected boxes is less than or equal to a given threshold. This layer implements NMS per batch item and per class.

For each batch item, the ordering of candidate bounding boxes with the same score is unspecified.

The layer has the following inputs, in order of input index:

• Boxes contains the input bounding boxes. It is a linear tensor of type kFLOAT or kHALF. It has shape [batchSize, numInputBoundingBoxes, numClasses, 4] if the boxes are per class, or [batchSize, numInputBoundingBoxes, 4] if the same boxes are to be used for each class.
• Scores contains the per-box scores. It is a linear tensor of the same type as Boxes. It has shape [batchSize, numInputBoundingBoxes, numClasses].
• MaxOutputBoxesPerClass is the maximum number of output boxes per batch item per class. It is a scalar (0D tensor) of type kINT32.
• IoUThreshold is the maximum IoU for selected boxes. It is a scalar (0D tensor) of type kFLOAT in the range [0.0f, 1.0f]. It is an optional input with default 0.0f.
• ScoreThreshold is the value that a box score must exceed in order to be selected. It is a scalar (0D tensor) of type kFLOAT. It is an optional input with default 0.0f.

The layer has the following outputs, in order of output index:

• SelectedIndices contains the indices of the selected boxes. It is a linear tensor of type kINT32. It has shape [NumOutputBoxes, 3]. Each row contains a (batchIndex, classIndex, boxIndex) tuple. The output boxes are sorted in order of increasing batchIndex and then in order of decreasing score within each batchIndex. For each batchIndex, the ordering of output boxes with the same score is unspecified. If MaxOutputBoxesPerClass is a constant input, the maximum number of output boxes is batchSize * numClasses * min(numInputBoundingBoxes, MaxOutputBoxesPerClass). Otherwise, the maximum number of output boxes is batchSize * numClasses * numInputBoundingBoxes. The maximum number of output boxes is used to determine the upper-bound on allocated memory for this output tensor.
• NumOutputBoxes is the number of output boxes in SelectedIndices. It is a scalar (0D tensor) of type kINT32.

Warning

There is a hardware-dependent limit K such that only the K highest scoring boxes in each batch item will be considered for selection. The value of K is 2000 for SM 5.3 and 6.2 devices, and 5000 otherwise.

Do not inherit from this class, as doing so will break forward-compatibility of the API and ABI.

Constructor & Destructor Documentation

~INMSLayer()

virtual nvinfer1::INMSLayer::~INMSLayer ( )

protectedvirtualdefaultnoexcept

Member Function Documentation

getBoundingBoxFormat()

BoundingBoxFormat nvinfer1::INMSLayer::getBoundingBoxFormat ( ) const

inlinenoexcept

Get the bounding box format parameter for the layer.

See also

BoundingBoxFormat

setBoundingBoxFormat()

getTopKBoxLimit()

int32_t nvinfer1::INMSLayer::getTopKBoxLimit ( ) const

inlinenoexcept

Get the TopK box limit parameter for the layer.

See also

setTopKBoxLimit()

setBoundingBoxFormat()

void nvinfer1::INMSLayer::setBoundingBoxFormat ( BoundingBoxFormat  fmt )

inlinenoexcept

Set the bounding box format parameter for the layer.

The default value for the bounding box format parameter is kCORNER_PAIRS.

See also

BoundingBoxFormat

getBoundingBoxFormat()

setInput()

void nvinfer1::ILayer::setInput ( int32_t  index, ITensor &  tensor  )

inlinenoexcept

Append or replace an input of this layer with a specific tensor.

Parameters

index	the index of the input to modify.
tensor	the new input tensor

The indices are as follows:

• 0: The required Boxes tensor.
• 1: The required Scores tensor.
• 2: The required MaxOutputBoxesPerClass tensor.
• 3: The optional IoUThreshold tensor.
• 4: The optional ScoreThreshold tensor.

If this function is called for an index greater or equal to getNbInputs(), then afterwards getNbInputs() returns index + 1, and any missing intervening inputs are set to null. Note that only optional inputs can be missing.

setTopKBoxLimit()

void nvinfer1::INMSLayer::setTopKBoxLimit ( int32_t  limit )

inlinenoexcept

Set the TopK box limit parameter for the layer.

The TopK box limit is the maximum number of filtered boxes considered for selection per batch item. The default value for the TopK box limit parameter is 2000 for SM 5.3 and 6.2 devices, and 5000 otherwise. The TopK box limit must be less than or equal to {2000 for SM 5.3 and 6.2 devices, 5000 otherwise}.

See also

getTopKBoxLimit()

Member Data Documentation

mImpl

apiv::VNMSLayer* nvinfer1::INMSLayer::mImpl

protected

---

The documentation for this class was generated from the following file:

• NvInfer.h