Compute Library
 22.08
CPPNonMaximumSuppression.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_CPP_NONMAXIMUMSUPPRESSION_LAYER_H
25 #define ARM_COMPUTE_CPP_NONMAXIMUMSUPPRESSION_LAYER_H
26 
28 
29 #include "arm_compute/core/Types.h"
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 
35 /** CPP Function to perform non maximum suppression on the bounding boxes and scores
36  *
37  */
39 {
40 public:
41  /** Configure the function to perform non maximal suppression
42  *
43  * @param[in] bboxes The input bounding boxes. Data types supported: F32.
44  * @param[in] scores The corresponding input confidence. Same as @p bboxes.
45  * @param[out] indices The kept indices of bboxes after nms. Data types supported: S32.
46  * @param[in] max_output_size An integer tensor representing the maximum number of boxes to be selected by non max suppression.
47  * @param[in] score_threshold The threshold used to filter detection results.
48  * @param[in] nms_threshold The threshold used in non maximum suppression.
49  *
50  */
51  void configure(const ITensor *bboxes, const ITensor *scores, ITensor *indices, unsigned int max_output_size, const float score_threshold, const float nms_threshold);
52 
53  /** Static function to check if given arguments will lead to a valid configuration of @ref CPPNonMaximumSuppression
54  *
55  * @param[in] bboxes The input bounding boxes tensor info. Data types supported: F32.
56  * @param[in] scores The corresponding input confidence tensor info. Same as @p bboxes.
57  * @param[out] indices The kept indices of bboxes after nms tensor info. Data types supported: S32.
58  * @param[in] max_output_size An integer tensor representing the maximum number of boxes to be selected by non max suppression.
59  * @param[in] score_threshold The threshold used to filter detection results.
60  * @param[in] nms_threshold The threshold used in non maximum suppression.
61  *
62  */
63  static Status validate(const ITensorInfo *bboxes, const ITensorInfo *scores, const ITensorInfo *indices, unsigned int max_output_size,
64  const float score_threshold, const float nms_threshold);
65 };
66 } // namespace arm_compute
67 #endif /* ARM_COMPUTE_CPP_NONMAXIMUMSUPPRESSION_LAYER_H */
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
Basic interface for functions which have a single CPP kernel.
static Status validate(const ITensorInfo *bboxes, const ITensorInfo *scores, const ITensorInfo *indices, unsigned int max_output_size, const float score_threshold, const float nms_threshold)
Static function to check if given arguments will lead to a valid configuration of CPPNonMaximumSuppre...
void configure(const ITensor *bboxes, const ITensor *scores, ITensor *indices, unsigned int max_output_size, const float score_threshold, const float nms_threshold)
Configure the function to perform non maximal suppression.
CPP Function to perform non maximum suppression on the bounding boxes and scores. ...