1 /* 2 * Copyright (c) 2017-2020 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/CL/ICLArray.h" 28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h" 29 30 namespace arm_compute 31 { 32 class CLCompileContext; 33 class ICLTensor; 34 class ROIPoolingLayerInfo; 35 36 /** Basic function to run @ref CLROIPoolingLayerKernel. 37 * 38 * This function calls the following OpenCL kernels: 39 * -# @ref CLROIPoolingLayerKernel 40 * 41 */ 42 class CLROIPoolingLayer : public ICLSimpleFunction 43 { 44 public: 45 /** Set the input and output tensors. 46 * 47 * @param[in] input Source tensor. Data types supported: F16/F32. 48 * @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 49 * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16 50 * @param[out] output Destination tensor. Data types supported: Same as @p input. 51 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 52 * 53 * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled 54 * width and pooled height. 55 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 56 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 57 */ 58 void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info); 59 /** Set the input and output tensors. 60 * 61 * @param[in] compile_context The compile context to be used. 62 * @param[in] input Source tensor. Data types supported: F16/F32. 63 * @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 64 * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16 65 * @param[out] output Destination tensor. Data types supported: Same as @p input. 66 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 67 * 68 * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled 69 * width and pooled height. 70 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 71 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 72 */ 73 void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info); 74 }; 75 } 76 #endif /* ARM_COMPUTE_CLROIPOOLINGLAYER_H */ 77