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_NEROIPOOLINGLAYER_H 25 #define ARM_COMPUTE_NEROIPOOLINGLAYER_H 26 27 #include "arm_compute/core/IArray.h" 28 #include "arm_compute/runtime/IFunction.h" 29 #include <memory> 30 31 namespace arm_compute 32 { 33 class ITensor; 34 class ITensorInfo; 35 class NEROIPoolingLayerKernel; 36 class ROIPoolingLayerInfo; 37 38 /** Basic function to run @ref NEROIPoolingLayerKernel. */ 39 class NEROIPoolingLayer : public IFunction 40 { 41 public: 42 /** Constructor */ 43 NEROIPoolingLayer(); 44 /** Prevent instances of this class from being copied (As this class contains pointers) */ 45 NEROIPoolingLayer(const NEROIPoolingLayer &) = delete; 46 /** Prevent instances of this class from being copied (As this class contains pointers) */ 47 NEROIPoolingLayer &operator=(const NEROIPoolingLayer &) = delete; 48 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 49 NEROIPoolingLayer(NEROIPoolingLayer &&) = delete; 50 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 51 NEROIPoolingLayer &operator=(NEROIPoolingLayer &&) = delete; 52 /** Default destructor */ 53 ~NEROIPoolingLayer(); 54 /** Set the input and output tensors. 55 * 56 * Valid data layouts: 57 * - All 58 * 59 * Valid data type configurations: 60 * |src0 |src1 |dst | 61 * |:--------------|:--------------|:--------------| 62 * |F32 |U16 |F32 | 63 * |QASYMM8 |U16 |QASYMM8 | 64 * 65 * @param[in] input Source tensor. Data types supported: QASYMM8/F32 66 * @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 67 * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16 68 * @param[out] output Destination tensor. Data types supported: Same as @p input. 69 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 70 * 71 * @note The x and y dimensions of @p output tensor must be the same as that specified by @p pool_info 's pooled 72 * width and pooled height. 73 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 74 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 75 */ 76 void configure(const ITensor *input, const ITensor *rois, const ITensor *output, const ROIPoolingLayerInfo &pool_info); 77 78 // Inherited methods overridden: 79 void run() override; 80 81 /** Static function to check if given info will lead to a valid configuration of @ref NEROIPoolingLayerKernel 82 * 83 * @param[in] input Source tensor info. Data types supported: QASYMM8/F32. 84 * @param[in] rois TensorInfo for rois tensor which is a 2D tensor of size [5,N] (where 5 is the number ROIs). Data types supported: U16 85 * @param[in] output Destination tensor info. Data types supported: Same as @p input. 86 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 87 * 88 * @note The x and y dimensions of @p output tensor must be the same as that specified by @p pool_info 's pooled 89 * width and pooled height. 90 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 91 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 92 * @return a Status 93 */ 94 static Status validate(const ITensorInfo *input, const ITensorInfo *rois, const ITensorInfo *output, const ROIPoolingLayerInfo &pool_info); 95 96 private: 97 std::unique_ptr<NEROIPoolingLayerKernel> _roi_kernel; 98 }; 99 } // namespace arm_compute 100 #endif /* ARM_COMPUTE_NEROIPOOLINGLAYER_H */ 101