24.02.1
CLROIAlignLayer.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2018-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_CLROIALIGNLAYER_H
25
#define ARM_COMPUTE_CLROIALIGNLAYER_H
26
27
#include "
arm_compute/core/CL/ICLArray.h
"
28
#include "
arm_compute/runtime/CL/ICLSimpleFunction.h
"
29
30
namespace
arm_compute
31
{
32
class
CLCompileContext;
33
class
ICLTensor;
34
class
ROIPoolingLayerInfo;
35
class
ITensorInfo;
36
37
/** Basic function to run @ref CLROIAlignLayerKernel.
38
*
39
* This function calls the following OpenCL kernels:
40
* -# @ref CLROIAlignLayerKernel
41
*
42
*/
43
class
CLROIAlignLayer
:
public
ICLSimpleFunction
44
{
45
public
:
46
/** Set the input and output tensors.
47
*
48
* Valid data layouts:
49
* - All
50
*
51
* Valid data type configurations:
52
* |src0 |src1 |dst |
53
* |:--------------|:--------------|:--------------|
54
* |F16 |F16 |F16 |
55
* |F32 |F32 |F32 |
56
* |QASYMM8 |QASYMM16 |QASYMM8 |
57
* |QASYMM8_SIGNED |QASYMM16 |QASYMM8_SIGNED |
58
*
59
* @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
60
* @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
61
* as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ].
62
* Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p input is QASYMM8/QASYMM8_SIGNED, otherwise same as @p input
63
* @param[out] output Destination tensor. Data types supported: Same as @p input.
64
* @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
65
*
66
* @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
67
* width and pooled height.
68
* @note The z dimensions of @p output tensor and @p input tensor must be the same.
69
* @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
70
*/
71
void
72
configure
(
const
ICLTensor
*
input
,
const
ICLTensor
*rois,
ICLTensor
*output,
const
ROIPoolingLayerInfo
&pool_info);
73
/** Set the input and output tensors.
74
*
75
* @param[in] compile_context The compile context to be used.
76
* @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
77
* @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
78
* as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ].
79
* Data types supported: QASYMM16 with scale of 0.125 and 0 offset if @p input is QASYMM8/QASYMM8_SIGNED, otherwise same as @p input
80
* @param[out] output Destination tensor. Data types supported: Same as @p input.
81
* @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
82
*
83
* @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
84
* width and pooled height.
85
* @note The z dimensions of @p output tensor and @p input tensor must be the same.
86
* @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
87
*/
88
void
configure
(
const
CLCompileContext
&compile_context,
89
const
ICLTensor
*
input
,
90
const
ICLTensor
*rois,
91
ICLTensor
*output,
92
const
ROIPoolingLayerInfo
&pool_info);
93
/** Static function to check if given info will lead to a valid configuration of @ref CLROIAlignLayer
94
*
95
* @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
96
* @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,
97
* otherwise same as @p input
98
* @param[in] output Destination tensor info. Data types supported: Same as @p input.
99
* @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
100
*
101
* @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
102
* width and pooled height.
103
* @note The z dimensions of @p output tensor and @p input tensor must be the same.
104
* @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
105
*
106
* @return a Status
107
*/
108
static
Status
validate
(
const
ITensorInfo
*
input
,
109
const
ITensorInfo
*rois,
110
ITensorInfo
*output,
111
const
ROIPoolingLayerInfo
&pool_info);
112
};
113
}
// namespace arm_compute
114
#endif
/* ARM_COMPUTE_CLROIALIGNLAYER_H */
arm_compute::CLROIAlignLayer::configure
void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info)
Set the input and output tensors.
Definition:
CLROIAlignLayer.cpp:44
arm_compute::CLROIAlignLayer::validate
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.
Definition:
CLROIAlignLayer.cpp:34
arm_compute::ICLTensor
Interface for OpenCL tensor.
Definition:
ICLTensor.h:41
ICLSimpleFunction.h
arm_compute::CLCompileContext
CLCompileContext class.
Definition:
CLCompileContext.h:204
arm_compute::ICLSimpleFunction
Basic interface for functions which have a single OpenCL kernel.
Definition:
ICLSimpleFunction.h:39
arm_compute::Status
Status class.
Definition:
Error.h:52
arm_compute::CLROIAlignLayer
Basic function to run CLROIAlignLayerKernel.
Definition:
CLROIAlignLayer.h:43
arm_compute
Copyright (c) 2017-2024 Arm Limited.
Definition:
introduction.dox:24
arm_compute::ITensorInfo
Store the tensor's metadata.
Definition:
ITensorInfo.h:44
arm_compute::ROIPoolingLayerInfo
ROI Pooling Layer Information class.
Definition:
Types.h:1259
arm_compute::test::validation::input
auto input
Definition:
LSTMLayerQuantized.cpp:486
ICLArray.h
arm_compute
runtime
CL
functions
CLROIAlignLayer.h
Generated on Mon Mar 18 2024 11:31:55 for Compute Library by
1.8.17