Compute Library
 20.02.1
CLROIAlignLayer.h
Go to the documentation of this file.
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_CLROIALIGNLAYER_H
25 #define ARM_COMPUTE_CLROIALIGNLAYER_H
26 
30 
31 namespace arm_compute
32 {
33 class ICLTensor;
34 
35 /** Basic function to run @ref CLROIAlignLayerKernel.
36  *
37  * This function calls the following OpenCL kernels:
38  * -# @ref CLROIAlignLayerKernel
39  *
40  */
42 {
43 public:
44  /** Set the input and output tensors.
45  *
46  * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
47  * @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
48  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ].
49  * Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p input is QASYMM8/QASYMM8_SIGNED, otherwise same as @p input
50  * @param[out] output Destination tensor. Data types supported: Same as @p input.
51  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
52  *
53  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
54  * width and pooled height.
55  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
56  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
57  */
58  void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info);
59  /** Static function to check if given info will lead to a valid configuration of @ref CLROIAlignLayer
60  *
61  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
62  * @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,
63  * otherwise same as @p input
64  * @param[in] output Destination tensor info. Data types supported: Same as @p input.
65  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
66  *
67  * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
68  * width and pooled height.
69  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
70  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
71  *
72  * @return a Status
73  */
74  static Status validate(const ITensorInfo *input, const ITensorInfo *rois, ITensorInfo *output, const ROIPoolingLayerInfo &pool_info);
75 };
76 } // namespace arm_compute
77 #endif /* ARM_COMPUTE_CLROIALIGNLAYER_H */
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2020 ARM Limited.
Basic function to run CLROIAlignLayerKernel.
Basic interface for functions which have a single OpenCL kernel.
void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info)
Set the input and output tensors.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
ROI Pooling Layer Information class.
Definition: Types.h:1374
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 CLROIAlignLayer.