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