Compute Library
 21.05
CLROIPoolingLayerKernel.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_CLROIPOOLINGLAYERKERNEL_H
25 #define ARM_COMPUTE_CLROIPOOLINGLAYERKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 namespace arm_compute
29 {
30 class ICLTensor;
31 
32 /** Interface for the ROI pooling layer kernel */
34 {
35 public:
36  /** Default constructor */
38  /** Prevent instances of this class from being copied (As this class contains pointers) */
40  /** Prevent instances of this class from being copied (As this class contains pointers) */
42  /** Allow instances of this class to be moved */
44  /** Allow instances of this class to be moved */
46  /** Default destructor */
47  ~CLROIPoolingLayerKernel() = default;
48 
49  /** Set the input and output tensors.
50  *
51  * @param[in] input Source tensor. Data types supported: F16/F32.
52  * @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
53  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16
54  * @param[out] output Destination tensor. Data types supported: Same as @p input.
55  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
56  *
57  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
58  * width and pooled height.
59  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
60  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
61  */
62  void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info);
63  /** Set the input and output tensors.
64  *
65  * @param[in] compile_context The compile context to be used.
66  * @param[in] input Source tensor. Data types supported: F16/F32/QASYMM8
67  * @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
68  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16
69  * @param[out] output Destination tensor. Data types supported: Same as @p input.
70  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
71  *
72  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
73  * width and pooled height.
74  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
75  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
76  */
77  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *rois, const ICLTensor *output, const ROIPoolingLayerInfo &pool_info);
78 
79  // Inherited methods overridden:
80  void run(const Window &window, cl::CommandQueue &queue) override;
81 
82  /** Static Validate function to check inputs will lead to valid configuration of @ref CLROIPoolingLayer
83  *
84  * @param[in] input Source tensor. Data types supported: F16/F32/QASYMM8
85  * @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
86  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16
87  * @param[out] output Destination tensor. Data types supported: Same as @p input.
88  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
89  *
90  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
91  * width and pooled height.
92  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
93  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
94  */
95  static Status validate(const ITensorInfo *input, const ITensorInfo *rois, const ITensorInfo *output, const ROIPoolingLayerInfo &pool_info);
96 
97 private:
98  const ICLTensor *_input;
99  const ICLTensor *_rois;
100  const ICLTensor *_output;
101  ROIPoolingLayerInfo _pool_info;
102 };
103 } // namespace arm_compute
104 #endif /*ARM_COMPUTE_CLROIPOOLINGLAYERKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
static Status validate(const ITensorInfo *input, const ITensorInfo *rois, const ITensorInfo *output, const ROIPoolingLayerInfo &pool_info)
Static Validate function to check inputs will lead to valid configuration of CLROIPoolingLayer.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Interface for the ROI pooling layer kernel.
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
Copyright (c) 2017-2021 Arm Limited.
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
CLROIPoolingLayerKernel & operator=(const CLROIPoolingLayerKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
ROI Pooling Layer Information class.
Definition: Types.h:1237
void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info)
Set the input and output tensors.
Describe a multidimensional execution window.
Definition: Window.h:39
~CLROIPoolingLayerKernel()=default
Default destructor.