Compute Library
 22.05
CLROIAlignLayer.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_CLROIALIGNLAYER_H
25 #define ARM_COMPUTE_CLROIALIGNLAYER_H
26 
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ROIPoolingLayerInfo;
35 class ITensorInfo;
36 
37 /** Basic function to run @ref CLROIAlignLayerKernel.
38  *
39  * This function calls the following OpenCL kernels:
40  * -# @ref CLROIAlignLayerKernel
41  *
42  */
44 {
45 public:
46  /** Set the input and output tensors.
47  *
48  * Valid data layouts:
49  * - All
50  *
51  * Valid data type configurations:
52  * |src0 |src1 |dst |
53  * |:--------------|:--------------|:--------------|
54  * |F16 |F16 |F16 |
55  * |F32 |F32 |F32 |
56  * |QASYMM8 |QASYMM16 |QASYMM8 |
57  * |QASYMM8_SIGNED |QASYMM16 |QASYMM8_SIGNED |
58  *
59  * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
60  * @param[in] rois ROIs tensor, it is a 2D tensor of size [5, N] (where N is the number of ROIs) containing top left and bottom right corner
61  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ].
62  * Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p input is QASYMM8/QASYMM8_SIGNED, otherwise same as @p input
63  * @param[out] output Destination tensor. Data types supported: Same as @p input.
64  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
65  *
66  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
67  * width and pooled height.
68  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
69  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
70  */
71  void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info);
72  /** Set the input and output tensors.
73  *
74  * @param[in] compile_context The compile context to be used.
75  * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
76  * @param[in] rois ROIs tensor, it is a 2D tensor of size [5, N] (where N is the number of ROIs) containing top left and bottom right corner
77  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ].
78  * Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p input is QASYMM8/QASYMM8_SIGNED, otherwise same as @p input
79  * @param[out] output Destination tensor. Data types supported: Same as @p input.
80  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
81  *
82  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
83  * width and pooled height.
84  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
85  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
86  */
87  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info);
88  /** Static function to check if given info will lead to a valid configuration of @ref CLROIAlignLayer
89  *
90  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
91  * @param[in] rois ROIs tensor info. Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p input is QASYMM8/QASYMM8_SIGNED,
92  * otherwise same as @p input
93  * @param[in] output Destination tensor info. Data types supported: Same as @p input.
94  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
95  *
96  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
97  * width and pooled height.
98  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
99  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
100  *
101  * @return a Status
102  */
103  static Status validate(const ITensorInfo *input, const ITensorInfo *rois, ITensorInfo *output, const ROIPoolingLayerInfo &pool_info);
104 };
105 } // namespace arm_compute
106 #endif /* ARM_COMPUTE_CLROIALIGNLAYER_H */
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
Basic function to run CLROIAlignLayerKernel.
Basic interface for functions which have a single OpenCL kernel.
void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info)
Set the input and output tensors.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
ROI Pooling Layer Information class.
Definition: Types.h:1384
static Status validate(const ITensorInfo *input, const ITensorInfo *rois, ITensorInfo *output, const ROIPoolingLayerInfo &pool_info)
Static function to check if given info will lead to a valid configuration of CLROIAlignLayer.