Compute Library
 22.05
CLROIPoolingLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_CLROIPOOLINGLAYER_H
25 #define ARM_COMPUTE_CLROIPOOLINGLAYER_H
26 
27 #include "arm_compute/core/Error.h"
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 CLROIPoolingLayerKernel.
38  *
39  * This function calls the following OpenCL kernels:
40  * -# @ref CLROIPoolingLayerKernel
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 |U16 |F16 |
55  * |F32 |U16 |F32 |
56  * |QASYMM8 |U16 |QASYMM8 |
57  *
58  * @param[in] input Source tensor. Data types supported: F16/F32/QASYMM8
59  * @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
60  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16
61  * @param[out] output Destination tensor. Data types supported: Same as @p input.
62  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
63  *
64  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
65  * width and pooled height.
66  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
67  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
68  */
69  void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info);
70  /** Set the input and output tensors.
71  *
72  * @param[in] compile_context The compile context to be used.
73  * @param[in] input Source tensor. Data types supported: F16/F32/QASYMM8
74  * @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
75  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16
76  * @param[out] output Destination tensor. Data types supported: Same as @p input.
77  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
78  *
79  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
80  * width and pooled height.
81  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
82  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
83  */
84  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *rois, const ICLTensor *output, const ROIPoolingLayerInfo &pool_info);
85 
86  /** Static function to check if given info will lead to a valid configuration of @ref CLROIPoolingLayer
87  *
88  * @param[in] input Source tensor info. Data types supported: QASYMM8/F16/F32.
89  * @param[in] rois ROIs tensor info. Data types supported: U16
90  * @param[in] output Destination tensor info. Data types supported: Same as @p input.
91  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
92  *
93  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
94  * width and pooled height.
95  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
96  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
97  *
98  * @return a Status
99  */
100  static Status validate(const ITensorInfo *input, const ITensorInfo *rois, ITensorInfo *output, const ROIPoolingLayerInfo &pool_info);
101 };
102 } // namespace arm_compute
103 #endif /* ARM_COMPUTE_CLROIPOOLINGLAYER_H */
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
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 CLROIPoolingLayer.
Basic interface for functions which have a single OpenCL kernel.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
ROI Pooling Layer Information class.
Definition: Types.h:1384
Basic function to run CLROIPoolingLayerKernel.
void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info)
Set the input and output tensors.