Compute Library
 22.05
CLBoundingBoxTransform.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_CLBOUNDINGBOXTRANSOFORM_H
25 #define ARM_COMPUTE_CLBOUNDINGBOXTRANSOFORM_H
26 
27 #include "arm_compute/core/Error.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class CLBoundingBoxTransformKernel;
34 class BoundingBoxTransformInfo;
35 class ICLTensor;
36 class ITensorInfo;
37 
38 /** Basic function to run @ref CLBoundingBoxTransformKernel.
39  *
40  * This function calls the following OpenCL kernels:
41  * -# @ref CLBoundingBoxTransformKernel
42  */
44 {
45 public:
46  /** Set the input and output tensors.
47  *
48  * Valid data layouts:
49  * - NHWC
50  * - NCHW
51  *
52  * Valid data type configurations:
53  * |src0 |src1 |dst |
54  * |:--------------|:--------------|:--------------|
55  * |QASYMM16 |QASYMM8 |QASYMM16 |
56  * |F16 |F16 |F16 |
57  * |F32 |F32 |F32 |
58  *
59  * @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.
60  * @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
61  * @param[in] deltas Bounding box translations and scales. Size (M, 4*K), format [dx, dy, dw, dh], K is the number of classes.
62  * Data types supported: QASYMM8 if @p input is QASYMM16, otherwise same as @p input
63  * @param[in] info Contains BoundingBox operation information described in @ref BoundingBoxTransformInfo.
64  *
65  * @note Only single image prediction is supported. Height and Width (and scale) of the image will be contained in the BoundingBoxTransformInfo struct.
66  */
67  void configure(const ICLTensor *boxes, ICLTensor *pred_boxes, const ICLTensor *deltas, const BoundingBoxTransformInfo &info);
68  /** Set the input and output tensors.
69  *
70  * @param[in] compile_context The compile context to be used.
71  * @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.
72  * @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
73  * @param[in] deltas Bounding box translations and scales. Size (M, 4*K), format [dx, dy, dw, dh], K is the number of classes.
74  * Data types supported: QASYMM8 if @p input is QASYMM16, otherwise same as @p input
75  * @param[in] info Contains BoundingBox operation information described in @ref BoundingBoxTransformInfo.
76  *
77  * @note Only single image prediction is supported. Height and Width (and scale) of the image will be contained in the BoundingBoxTransformInfo struct.
78  */
79  void configure(const CLCompileContext &compile_context, const ICLTensor *boxes, ICLTensor *pred_boxes, const ICLTensor *deltas, const BoundingBoxTransformInfo &info);
80 
81  /** Static function to check if given info will lead to a valid configuration of @ref CLBoundingBoxTransform
82  *
83  * @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.
84  * @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
85  * @param[in] deltas Bounding box translations and scales. Size (M, 4*K), format [dx, dy, dw, dh], K is the number of classes.
86  * Data types supported: QASYMM8 if @p input is QASYMM16, otherwise same as @p input
87  * @param[in] info Contains BoundingBox operation information described in @ref BoundingBoxTransformInfo.
88  *
89  * @note Only single image prediction is supported. Height and Width (and scale) of the image will be contained in the BoundingBoxTransformInfo struct.
90  *
91  * @return a Status
92  */
93  static Status validate(const ITensorInfo *boxes, const ITensorInfo *pred_boxes, const ITensorInfo *deltas, const BoundingBoxTransformInfo &info);
94 };
95 } // namespace arm_compute
96 #endif /* ARM_COMPUTE_CLBOUNDINGBOXTRANSFORM_H */
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.
Basic function to run CLBoundingBoxTransformKernel.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
Basic interface for functions which have a single OpenCL kernel.
Bounding Box Transform information class.
Definition: Types.h:1558
CLCompileContext class.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void configure(const ICLTensor *boxes, ICLTensor *pred_boxes, const ICLTensor *deltas, const BoundingBoxTransformInfo &info)
Set the input and output tensors.