Compute Library
 22.05
CLPriorBoxLayer.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_CLPRIORBOXLAYER_H
25 #define ARM_COMPUTE_CLPRIORBOXLAYER_H
26 
28 #include "arm_compute/core/Types.h"
30 
31 namespace arm_compute
32 {
33 class CLCompileContext;
34 class CLPriorBoxLayerKernel;
35 class ICLTensor;
36 class ITensorInfo;
37 
38 /** Basic function to run @ref CLPriorBoxLayerKernel. */
40 {
41 public:
42  /** Constructor */
44  /** Set the input and output tensors.
45  *
46  * Valid data layouts:
47  * - NHWC
48  * - NCHW
49  *
50  * Valid data type configurations:
51  * |src0 |src1 |dst |
52  * |:--------|:--------|:--------|
53  * |F32 |F32 |F32 |
54  *
55  * @param[in] input1 First source tensor. Data types supported: F32. Data layouts supported: NCHW/NHWC.
56  * @param[in] input2 Second source tensor. Data types and layouts supported: same as @p input1
57  * @param[out] output Destination tensor. Output dimensions are [W * H * num_priors * 4, 2]. Data types and layouts supported: same as @p input1
58  * @param[in] info Prior box layer info.
59  */
60  void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const PriorBoxLayerInfo &info);
61  /** Set the input and output tensors.
62  *
63  * @param[in] compile_context The compile context to be used.
64  * @param[in] input1 First source tensor. Data types supported: F32. Data layouts supported: NCHW/NHWC.
65  * @param[in] input2 Second source tensor. Data types and layouts supported: same as @p input1
66  * @param[out] output Destination tensor. Output dimensions are [W * H * num_priors * 4, 2]. Data types and layouts supported: same as @p input1
67  * @param[in] info Prior box layer info.
68  */
69  void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const PriorBoxLayerInfo &info);
70  /** Static function to check if given info will lead to a valid configuration of @ref CLPriorBoxLayer
71  *
72  * @param[in] input1 First source tensor info. Data types supported: F32. Data layouts supported: NCHW/NHWC.
73  * @param[in] input2 Second source tensor info. Data types and layouts supported: same as @p input1
74  * @param[in] output Destination tensor info. Output dimensions are [W * H * num_priors * 4, 2]. Data types and layouts supported: same as @p input1
75  * @param[in] info Prior box layer info.
76  *
77  * @return a status
78  */
79  static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, const PriorBoxLayerInfo &info);
80 
81 private:
82  cl::Buffer _min;
83  cl::Buffer _max;
84  cl::Buffer _aspect_ratios;
85 };
86 } // arm_compute
87 #endif /* ARM_COMPUTE_CLPRIORBOXLAYER_H */
void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const PriorBoxLayerInfo &info)
Set the input and output tensors.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, const PriorBoxLayerInfo &info)
Static function to check if given info will lead to a valid configuration of CLPriorBoxLayer.
Basic function to run CLPriorBoxLayerKernel.
Basic interface for functions which have a single OpenCL kernel.
PriorBox layer info.
Definition: Types.h:811
CLCompileContext class.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Wrapper to configure the Khronos OpenCL C++ header.