xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEBoundingBoxTransform.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019-2021 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_NEBOUNDINGBOXTRANSOFORM_H
25 #define ARM_COMPUTE_NEBOUNDINGBOXTRANSOFORM_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 class ITensorInfo;
34 
35 /** Basic function to run @ref NEBoundingBoxTransformKernel. */
36 class NEBoundingBoxTransform : public INESimpleFunctionNoBorder
37 {
38 public:
39     /** Set the input and output tensors.
40      *
41      * Valid data layouts:
42      * - NHWC
43      * - NCHW
44      *
45      * Valid data type configurations:
46      * |src0           |src1           |dst            |
47      * |:--------------|:--------------|:--------------|
48      * |QASYMM16       |QASYMM8        |QASYMM16       |
49      * |F16            |F16            |F16            |
50      * |F32            |F32            |F32            |
51      *
52      * @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.
53      * @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
54      * @param[in]  deltas     Bounding box translations and scales. Size (M, 4*K), format [dx, dy, dw, dh], K  is the number of classes.
55      *                        Data types supported: QASYMM8 if @p input is QASYMM16, otherwise same as @p input.
56      * @param[in]  info       Contains BoundingBox operation information described in @ref BoundingBoxTransformInfo.
57      *
58      * @note Only single image prediction is supported. Height and Width (and scale) of the image will be contained in the BoundingBoxTransformInfo struct.
59      */
60     void configure(const ITensor *boxes, ITensor *pred_boxes, const ITensor *deltas, const BoundingBoxTransformInfo &info);
61 
62     /** Static function to check if given info will lead to a valid configuration of @ref NEBoundingBoxTransform
63      *
64      * @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.
65      * @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
66      * @param[in] deltas     Bounding box translations and scales. Size (M, 4*K), format [dx, dy, dw, dh], K  is the number of classes.
67      *                       Data types supported: QASYMM8 if @p input is QASYMM16, otherwise same as @p input.
68      * @param[in] info       Contains BoundingBox operation information described in @ref BoundingBoxTransformInfo.
69      *
70      * @note Only single image prediction is supported. Height and Width (and scale) of the image will be contained in the BoundingBoxTransformInfo struct.
71      *
72      * @return a Status
73      */
74     static Status validate(const ITensorInfo *boxes, const ITensorInfo *pred_boxes, const ITensorInfo *deltas, const BoundingBoxTransformInfo &info);
75 };
76 } // namespace arm_compute
77 #endif /* ARM_COMPUTE_NEBOUNDINGBOXTRANSFORM_H */
78