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