Compute Library
 21.02
NEROIAlignLayerKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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_NEROIALIGNLAYERKERNEL_H
25 #define ARM_COMPUTE_NEROIALIGNLAYERKERNEL_H
26 
28 
29 namespace arm_compute
30 {
31 class ITensor;
32 
33 /** Interface for the RoIAlign kernel.
34  */
36 {
37 public:
38  const char *name() const override
39  {
40  return "NEROIAlignLayerKernel";
41  }
42 
43  /** Constructor */
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  /** Default Move Constructor. */
51  /** Default move assignment operator. */
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  template <typename input_data_type, typename roi_data_type = input_data_type>
93  void internal_run(const Window &window, const ThreadInfo &info);
94 
95  const ITensor *_input;
96  ITensor *_output;
97  const ITensor *_rois;
98  ROIPoolingLayerInfo _pool_info;
99 };
100 } // namespace arm_compute
101 #endif /*ARM_COMPUTE_NEROIALIGNLAYERKERNEL_H*/
~NEROIAlignLayerKernel()=default
Default destructor.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
const char * name() const override
Name of the kernel.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
Information about executing thread and CPU.
Definition: CPPTypes.h:235
ROI Pooling Layer Information class.
Definition: Types.h:1309
NEROIAlignLayerKernel & operator=(const NEROIAlignLayerKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void configure(const ITensor *input, const ITensor *rois, ITensor *output, const ROIPoolingLayerInfo &pool_info)
Set the input and output tensors.
Describe a multidimensional execution window.
Definition: Window.h:39
static Status validate(const ITensorInfo *input, const ITensorInfo *rois, ITensorInfo *output, const ROIPoolingLayerInfo &pool_info)
Static function to check if given info will lead to a valid configuration of NEROIAlignLayerKernel.
Interface for the RoIAlign kernel.