Compute Library
 21.02
BoxNMSLimitInfo Class Referencefinal

BoxWithNonMaximaSuppressionLimit Information class. More...

#include <Types.h>

Public Member Functions

 BoxNMSLimitInfo (float score_thresh=0.05f, float nms=0.3f, int detections=100, bool soft_nms_enabled=false, NMSType soft_nms_method=NMSType::LINEAR, float soft_nms_sigma=0.5f, float soft_nms_min_score_thres=0.001f, bool suppress_size=false, float min_size=1.0f, float im_width=1.0f, float im_height=1.0f)
 Constructor. More...
 
float score_thresh () const
 Get the score threshold. More...
 
float nms () const
 Get the NMS. More...
 
int detections_per_im () const
 Get the number of detections. More...
 
bool soft_nms_enabled () const
 Check if soft NMS is enabled. More...
 
NMSType soft_nms_method () const
 Get soft NMS method. More...
 
float soft_nms_sigma () const
 Get soft NMS sigma. More...
 
float soft_nms_min_score_thres () const
 Get soft nms min score threshold. More...
 
bool suppress_size () const
 Get if NMS will suppress boxes based on their size/position. More...
 
float min_size () const
 Get size suppression threshold. More...
 
float im_width () const
 Get image width (NMS may suppress boxes whose center sits beyond the image width) More...
 
float im_height () const
 Get image height (NMS may suppress boxes whose center sits beyond the image height) More...
 

Detailed Description

BoxWithNonMaximaSuppressionLimit Information class.

Definition at line 626 of file Types.h.

Constructor & Destructor Documentation

◆ BoxNMSLimitInfo()

BoxNMSLimitInfo ( float  score_thresh = 0.05f,
float  nms = 0.3f,
int  detections = 100,
bool  soft_nms_enabled = false,
NMSType  soft_nms_method = NMSType::LINEAR,
float  soft_nms_sigma = 0.5f,
float  soft_nms_min_score_thres = 0.001f,
bool  suppress_size = false,
float  min_size = 1.0f,
float  im_width = 1.0f,
float  im_height = 1.0f 
)
inline

Constructor.

Parameters
[in]score_thresh(Optional) Score threshold.
[in]nms(Optional) NMS value
[in]detections(Optional) Number of detections
[in]soft_nms_enabled(Optional) Enable SoftNMS
[in]soft_nms_method(Optional) Soft NMS method
[in]soft_nms_sigma(Optional) Soft NMS sigma value
[in]soft_nms_min_score_thres(Optional) Soft NMS minimum score threshold
[in]suppress_size(Optional) Filter out boxes based on their size. Defaults to false
[in]min_size(Optional) Smaller boxes than min_size will be filtered out. Defaults to 1
[in]im_width(Optional) Boxes whose centers (on the x axis) is beyond im_width will be filtered. Defaults to 1
[in]im_height(Optional) Boxes whose centers (on the y axis) is beyond im_height will be filtered. Defaults to 1

Definition at line 643 of file Types.h.

647  : _score_thresh(score_thresh), _nms(nms), _detections_per_im(detections), _soft_nms_enabled(soft_nms_enabled), _soft_nms_method(soft_nms_method), _soft_nms_sigma(soft_nms_sigma),
648  _soft_nms_min_score_thres(soft_nms_min_score_thres), _suppress_size(suppress_size), _min_size(min_size), _im_width(im_width), _im_height(im_height)
649  {
650  }
float im_width() const
Get image width (NMS may suppress boxes whose center sits beyond the image width) ...
Definition: Types.h:697
float score_thresh() const
Get the score threshold.
Definition: Types.h:652
bool suppress_size() const
Get if NMS will suppress boxes based on their size/position.
Definition: Types.h:687
float nms() const
Get the NMS.
Definition: Types.h:657
float soft_nms_min_score_thres() const
Get soft nms min score threshold.
Definition: Types.h:682
float min_size() const
Get size suppression threshold.
Definition: Types.h:692
NMSType soft_nms_method() const
Get soft NMS method.
Definition: Types.h:672
float im_height() const
Get image height (NMS may suppress boxes whose center sits beyond the image height) ...
Definition: Types.h:702
float soft_nms_sigma() const
Get soft NMS sigma.
Definition: Types.h:677
bool soft_nms_enabled() const
Check if soft NMS is enabled.
Definition: Types.h:667

Member Function Documentation

◆ detections_per_im()

int detections_per_im ( ) const
inline

Get the number of detections.

Definition at line 662 of file Types.h.

Referenced by CPPBoxWithNonMaximaSuppressionLimitKernel::run_nmslimit().

663  {
664  return _detections_per_im;
665  }

◆ im_height()

float im_height ( ) const
inline

Get image height (NMS may suppress boxes whose center sits beyond the image height)

Definition at line 702 of file Types.h.

703  {
704  return _im_height;
705  }

◆ im_width()

float im_width ( ) const
inline

Get image width (NMS may suppress boxes whose center sits beyond the image width)

Definition at line 697 of file Types.h.

698  {
699  return _im_width;
700  }

◆ min_size()

float min_size ( ) const
inline

Get size suppression threshold.

Definition at line 692 of file Types.h.

693  {
694  return _min_size;
695  }

◆ nms()

float nms ( ) const
inline

Get the NMS.

Definition at line 657 of file Types.h.

658  {
659  return _nms;
660  }

◆ score_thresh()

float score_thresh ( ) const
inline

Get the score threshold.

Definition at line 652 of file Types.h.

Referenced by CPPBoxWithNonMaximaSuppressionLimitKernel::run_nmslimit().

653  {
654  return _score_thresh;
655  }

◆ soft_nms_enabled()

bool soft_nms_enabled ( ) const
inline

Check if soft NMS is enabled.

Definition at line 667 of file Types.h.

Referenced by CPPBoxWithNonMaximaSuppressionLimitKernel::run_nmslimit().

668  {
669  return _soft_nms_enabled;
670  }

◆ soft_nms_method()

NMSType soft_nms_method ( ) const
inline

Get soft NMS method.

Definition at line 672 of file Types.h.

673  {
674  return _soft_nms_method;
675  }

◆ soft_nms_min_score_thres()

float soft_nms_min_score_thres ( ) const
inline

Get soft nms min score threshold.

Definition at line 682 of file Types.h.

683  {
684  return _soft_nms_min_score_thres;
685  }

◆ soft_nms_sigma()

float soft_nms_sigma ( ) const
inline

Get soft NMS sigma.

Definition at line 677 of file Types.h.

678  {
679  return _soft_nms_sigma;
680  }

◆ suppress_size()

bool suppress_size ( ) const
inline

Get if NMS will suppress boxes based on their size/position.

Definition at line 687 of file Types.h.

688  {
689  return _suppress_size;
690  }

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