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_CLROIALIGNLAYERKERNEL_H 25 #define ARM_COMPUTE_CLROIALIGNLAYERKERNEL_H 26 27 #include "src/core/CL/ICLKernel.h" 28 namespace arm_compute 29 { 30 class ICLTensor; 31 32 /** Interface for the RoIAlign kernel. 33 */ 34 class CLROIAlignLayerKernel : public ICLKernel 35 { 36 public: 37 /** Constructor */ 38 CLROIAlignLayerKernel(); 39 /** Prevent instances of this class from being copied (As this class contains pointers) */ 40 CLROIAlignLayerKernel(const CLROIAlignLayerKernel &) = delete; 41 /** Prevent instances of this class from being copied (As this class contains pointers) */ 42 CLROIAlignLayerKernel &operator=(const CLROIAlignLayerKernel &) = delete; 43 /** Default Move Constructor. */ 44 CLROIAlignLayerKernel(CLROIAlignLayerKernel &&) = default; 45 /** Default move assignment operator. */ 46 CLROIAlignLayerKernel &operator=(CLROIAlignLayerKernel &&) = default; 47 /** Default destructor */ 48 ~CLROIAlignLayerKernel() = default; 49 50 /** Set the input and output tensors. 51 * 52 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 53 * @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 54 * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. 55 * Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p input is QASYMM8/QASYMM8_SIGNED, otherwise same as @p input 56 * @param[out] output Destination tensor. Data types supported: Same as @p input. 57 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 58 * 59 * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled 60 * width and pooled height. 61 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 62 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 63 */ 64 void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info); 65 /** Set the input and output tensors. 66 * 67 * @param[in] compile_context The compile context to be used. 68 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 69 * @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 70 * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. 71 * Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p input is QASYMM8/QASYMM8_SIGNED, otherwise same as @p input 72 * @param[out] output Destination tensor. Data types supported: Same as @p input. 73 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 74 * 75 * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled 76 * width and pooled height. 77 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 78 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 79 */ 80 void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info); 81 /** Static function to check if given info will lead to a valid configuration of @ref CLROIAlignLayerKernel 82 * 83 * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 84 * @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, 85 * otherwise same as @p input 86 * @param[in] output Destination tensor info. Data types supported: Same as @p input. 87 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 88 * 89 * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled 90 * width and pooled height. 91 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 92 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 93 * 94 * @return a Status 95 */ 96 static Status validate(const ITensorInfo *input, const ITensorInfo *rois, ITensorInfo *output, const ROIPoolingLayerInfo &pool_info); 97 98 // Inherited methods overridden: 99 void run(const Window &window, cl::CommandQueue &queue); 100 101 private: 102 const ICLTensor *_input; 103 ICLTensor *_output; 104 const ICLTensor *_rois; 105 ROIPoolingLayerInfo _pool_info; 106 }; 107 } // namespace arm_compute 108 #endif /*ARM_COMPUTE_CLROIALIGNLAYERKERNEL_H*/ 109