Compute Library
 22.05
NEBoundingBoxTransformKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2022 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_NEBOUNDINGBOXTRANSFORMKERNEL_H
25 #define ARM_COMPUTE_NEBOUNDINGBOXTRANSFORMKERNEL_H
26 
28 
29 namespace arm_compute
30 {
31 class ITensor;
32 
33 /** Interface for the bounding box kernel */
35 {
36 public:
37  const char *name() const override
38  {
39  return "NEBoundingBoxTransformKernel";
40  }
41 
42  /** Default constructor */
44  /** Prevent instances of this class from being copied (As this class contains pointers) */
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
48  /** Allow instances of this class to be moved */
50  /** Allow instances of this class to be moved */
52  /** Default destructor */
54 
55  /** Set the input and output tensors.
56  *
57  * @param[in] boxes Source tensor. Bounding box proposals in pixel coordinates. Size(M, 4), format [x1, y1, x2, y2]. Data types supported: QASYMM16/F16/F32.
58  * @param[out] pred_boxes Destination tensor. Pixel coordinates of the transformed bounding boxes. Size (M, 4*K), format [x1, y1, x2, y2]. Data types supported: Same as @p input
59  * @param[in] deltas Bounding box translations and scales. Size (M, 4*K), format [dx, dy, dw, dh], K is the number of classes.
60  * Data types supported: QASYMM8 if @p input is QASYMM16, otherwise same as @p input.
61  * @param[in] info Contains BoundingBox operation information described in @ref BoundingBoxTransformInfo.
62  *
63  * @note Only single image prediction is supported. Height and Width (and scale) of the image will be contained in the BoundingBoxTransformInfo struct.
64  *
65  */
66  void configure(const ITensor *boxes, ITensor *pred_boxes, const ITensor *deltas, const BoundingBoxTransformInfo &info);
67 
68  /** Static function to check if given info will lead to a valid configuration of @ref CLBoundingBoxTransform
69  *
70  * @param[in] boxes Source tensor info. Bounding box proposals in pixel coordinates. Size(M, 4), format [x1, y1, x2, y2]. Data types supported: QASYMM16/F16/F32.
71  * @param[in] pred_boxes Destination tensor info. Pixel coordinates of the transformed bounding boxes. Size (M, 4*K), format [x1, y1, x2, y2]. Data types supported: Same as @p input
72  * @param[in] deltas Bounding box translations and scales. Size (M, 4*K), format [dx, dy, dw, dh], K is the number of classes.
73  * Data types supported: QASYMM8 if @p input is QASYMM16, otherwise same as @p input.
74  * @param[in] info Contains BoundingBox operation information described in @ref BoundingBoxTransformInfo.
75  *
76  * @note Only single image prediction is supported. Height and Width (and scale) of the image will be contained in the BoundingBoxTransformInfo struct.
77  *
78  * @return a Status
79  */
80  static Status validate(const ITensorInfo *boxes, const ITensorInfo *pred_boxes, const ITensorInfo *deltas, const BoundingBoxTransformInfo &info);
81 
82  // Inherited methods overridden:
83  void run(const Window &window, const ThreadInfo &info) override;
84 
85 private:
86  const ITensor *_boxes;
87  ITensor *_pred_boxes;
88  const ITensor *_deltas;
90 };
91 } // namespace arm_compute
92 #endif /*ARM_COMPUTE_NEBOUNDINGBOXTRANSFORMKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
void configure(const ITensor *boxes, ITensor *pred_boxes, const ITensor *deltas, const BoundingBoxTransformInfo &info)
Set the input and output tensors.
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.
NEBoundingBoxTransformKernel & operator=(const NEBoundingBoxTransformKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
~NEBoundingBoxTransformKernel()=default
Default destructor.
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
Bounding Box Transform information class.
Definition: Types.h:1558
static Status validate(const ITensorInfo *boxes, const ITensorInfo *pred_boxes, const ITensorInfo *deltas, const BoundingBoxTransformInfo &info)
Static function to check if given info will lead to a valid configuration of CLBoundingBoxTransform.
const char * name() const override
Name of the kernel.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:169
Interface for the bounding box kernel.
Describe a multidimensional execution window.
Definition: Window.h:39