Compute Library
 21.02
DetectionPostProcessLayerInfo Class Referencefinal

Detection Output layer info. More...

#include <Types.h>

Public Member Functions

 DetectionPostProcessLayerInfo ()
 Default Constructor. More...
 
 DetectionPostProcessLayerInfo (unsigned int max_detections, unsigned int max_classes_per_detection, float nms_score_threshold, float iou_threshold, unsigned int num_classes, std::array< float, 4 > scales_values, bool use_regular_nms=false, unsigned int detection_per_class=100, bool dequantize_scores=true)
 Constructor. More...
 
unsigned int max_detections () const
 Get max detections. More...
 
unsigned int max_classes_per_detection () const
 Get max_classes per detection. More...
 
unsigned int detection_per_class () const
 Get detection per class. More...
 
float nms_score_threshold () const
 Get nms threshold. More...
 
float iou_threshold () const
 Get intersection over union threshold. More...
 
unsigned int num_classes () const
 Get num classes. More...
 
bool use_regular_nms () const
 Get if use regular nms. More...
 
float scale_value_y () const
 Get y scale value. More...
 
float scale_value_x () const
 Get x scale value. More...
 
float scale_value_h () const
 Get h scale value. More...
 
float scale_value_w () const
 Get w scale value. More...
 
bool dequantize_scores () const
 Get dequantize_scores value. More...
 

Detailed Description

Detection Output layer info.

Definition at line 1095 of file Types.h.

Constructor & Destructor Documentation

◆ DetectionPostProcessLayerInfo() [1/2]

Default Constructor.

Definition at line 1099 of file Types.h.

1100  : _max_detections(),
1101  _max_classes_per_detection(),
1102  _nms_score_threshold(),
1103  _iou_threshold(),
1104  _num_classes(),
1105  _scales_values(),
1106  _use_regular_nms(),
1107  _detection_per_class(),
1108  _dequantize_scores()
1109  {
1110  }

◆ DetectionPostProcessLayerInfo() [2/2]

DetectionPostProcessLayerInfo ( unsigned int  max_detections,
unsigned int  max_classes_per_detection,
float  nms_score_threshold,
float  iou_threshold,
unsigned int  num_classes,
std::array< float, 4 >  scales_values,
bool  use_regular_nms = false,
unsigned int  detection_per_class = 100,
bool  dequantize_scores = true 
)
inline

Constructor.

Parameters
[in]max_detectionsNumber of total detection.
[in]max_classes_per_detectionNumber of total classes to be kept after NMS step. Used in the Fast Non-Max-Suppression
[in]nms_score_thresholdThreshold to be used in NMS
[in]iou_thresholdThreshold to be used during the intersection over union.
[in]num_classesNumber of classes.
[in]scales_valuesScales values used for decode center size boxes.
[in]use_regular_nms(Optional) Boolean to determinate if use regular or fast nms. Defaults to false.
[in]detection_per_class(Optional) Number of detection per class. Used in the Regular Non-Max-Suppression. Defaults to 100.
[in]dequantize_scores(Optional) If the scores need to be dequantized. Defaults to true.

Definition at line 1123 of file Types.h.

1125  : _max_detections(max_detections),
1126  _max_classes_per_detection(max_classes_per_detection),
1127  _nms_score_threshold(nms_score_threshold),
1128  _iou_threshold(iou_threshold),
1129  _num_classes(num_classes),
1130  _scales_values(scales_values),
1131  _use_regular_nms(use_regular_nms),
1132  _detection_per_class(detection_per_class),
1133  _dequantize_scores(dequantize_scores)
1134  {
1135  }
unsigned int max_detections() const
Get max detections.
Definition: Types.h:1137
bool use_regular_nms() const
Get if use regular nms.
Definition: Types.h:1167
float iou_threshold() const
Get intersection over union threshold.
Definition: Types.h:1157
float nms_score_threshold() const
Get nms threshold.
Definition: Types.h:1152
bool dequantize_scores() const
Get dequantize_scores value.
Definition: Types.h:1196
unsigned int max_classes_per_detection() const
Get max_classes per detection.
Definition: Types.h:1142
unsigned int detection_per_class() const
Get detection per class.
Definition: Types.h:1147
unsigned int num_classes() const
Get num classes.
Definition: Types.h:1162

Member Function Documentation

◆ dequantize_scores()

bool dequantize_scores ( ) const
inline

Get dequantize_scores value.

Definition at line 1196 of file Types.h.

Referenced by CPPDetectionPostProcessLayer::configure().

1197  {
1198  return _dequantize_scores;
1199  }

◆ detection_per_class()

unsigned int detection_per_class ( ) const
inline

Get detection per class.

Used in the Regular Non-Max-Suppression

Definition at line 1147 of file Types.h.

Referenced by CPPDetectionPostProcessLayer::configure(), NEDetectionPostProcessLayer::configure(), arm_compute::operator<<(), and CPPDetectionPostProcessLayer::run().

1148  {
1149  return _detection_per_class;
1150  }

◆ iou_threshold()

float iou_threshold ( ) const
inline

Get intersection over union threshold.

Definition at line 1157 of file Types.h.

Referenced by CPPDetectionPostProcessLayer::configure(), NEDetectionPostProcessLayer::configure(), arm_compute::operator<<(), and CPPDetectionPostProcessLayer::validate().

1158  {
1159  return _iou_threshold;
1160  }

◆ max_classes_per_detection()

unsigned int max_classes_per_detection ( ) const
inline

Get max_classes per detection.

Used in the Fast Non-Max-Suppression.

Definition at line 1142 of file Types.h.

Referenced by CPPDetectionPostProcessLayer::configure(), NEDetectionPostProcessLayer::configure(), DetectionPostProcessLayerNode::configure_output(), arm_compute::operator<<(), and CPPDetectionPostProcessLayer::run().

1143  {
1144  return _max_classes_per_detection;
1145  }

◆ max_detections()

unsigned int max_detections ( ) const
inline

◆ nms_score_threshold()

float nms_score_threshold ( ) const
inline

Get nms threshold.

Definition at line 1152 of file Types.h.

Referenced by CPPDetectionPostProcessLayer::configure(), NEDetectionPostProcessLayer::configure(), arm_compute::operator<<(), and CPPDetectionPostProcessLayer::validate().

1153  {
1154  return _nms_score_threshold;
1155  }

◆ num_classes()

unsigned int num_classes ( ) const
inline

Get num classes.

Definition at line 1162 of file Types.h.

Referenced by CPPDetectionPostProcessLayer::configure(), NEDetectionPostProcessLayer::configure(), arm_compute::operator<<(), and CPPDetectionPostProcessLayer::run().

1163  {
1164  return _num_classes;
1165  }

◆ scale_value_h()

float scale_value_h ( ) const
inline

Get h scale value.

Definition at line 1184 of file Types.h.

Referenced by NEDetectionPostProcessLayer::configure(), and arm_compute::operator<<().

1185  {
1186  // Saved as [y,x,h,w]
1187  return _scales_values[2];
1188  }

◆ scale_value_w()

float scale_value_w ( ) const
inline

Get w scale value.

Definition at line 1190 of file Types.h.

Referenced by NEDetectionPostProcessLayer::configure(), and arm_compute::operator<<().

1191  {
1192  // Saved as [y,x,h,w]
1193  return _scales_values[3];
1194  }

◆ scale_value_x()

float scale_value_x ( ) const
inline

Get x scale value.

Definition at line 1178 of file Types.h.

Referenced by NEDetectionPostProcessLayer::configure(), and arm_compute::operator<<().

1179  {
1180  // Saved as [y,x,h,w]
1181  return _scales_values[1];
1182  }

◆ scale_value_y()

float scale_value_y ( ) const
inline

Get y scale value.

Definition at line 1172 of file Types.h.

Referenced by NEDetectionPostProcessLayer::configure(), and arm_compute::operator<<().

1173  {
1174  // Saved as [y,x,h,w]
1175  return _scales_values[0];
1176  }

◆ use_regular_nms()

bool use_regular_nms ( ) const
inline

Get if use regular nms.

Definition at line 1167 of file Types.h.

Referenced by CPPDetectionPostProcessLayer::configure(), NEDetectionPostProcessLayer::configure(), arm_compute::operator<<(), and CPPDetectionPostProcessLayer::run().

1168  {
1169  return _use_regular_nms;
1170  }

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