• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2017-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_CLREMAPKERNEL_H
25 #define ARM_COMPUTE_CLREMAPKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/CL/ICLKernel.h"
29 
30 namespace arm_compute
31 {
32 class ICLTensor;
33 
34 /** OpenCL kernel to perform a remap on a tensor */
35 class CLRemapKernel : public ICLKernel
36 {
37 public:
38     /** Default constructor */
39     CLRemapKernel();
40     /** Prevent instances of this class from being copied (As this class contains pointers) */
41     CLRemapKernel(const CLRemapKernel &) = delete;
42     /** Prevent instances of this class from being copied (As this class contains pointers) */
43     CLRemapKernel &operator=(const CLRemapKernel &) = delete;
44     /** Allow instances of this class to be moved */
45     CLRemapKernel(CLRemapKernel &&) = default;
46     /** Allow instances of this class to be moved */
47     CLRemapKernel &operator=(CLRemapKernel &&) = default;
48     /** Initialize the kernel's input, output and border mode.
49      *
50      * @param[in]  input            Source tensor. Data types supported: U8.
51      * @param[in]  map_x            Map for X coordinates. Data types supported: F32.
52      * @param[in]  map_y            Map for Y coordinates. Data types supported: F32.
53      * @param[out] output           Destination tensor. Data types supported: U8. All but the lowest two dimensions must be the same size as in the input tensor, i.e. remapping is only performed within the XY-plane.
54      * @param[in]  policy           The interpolation type.
55      * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
56      */
57     void configure(const ICLTensor *input, const ICLTensor *map_x, const ICLTensor *map_y, ICLTensor *output, InterpolationPolicy policy, bool border_undefined);
58     /** Initialize the kernel's input, output and border mode.
59      *
60      * @param[in]  compile_context  The compile context to be used.
61      * @param[in]  input            Source tensor. Data types supported: U8.
62      * @param[in]  map_x            Map for X coordinates. Data types supported: F32.
63      * @param[in]  map_y            Map for Y coordinates. Data types supported: F32.
64      * @param[out] output           Destination tensor. Data types supported: U8. All but the lowest two dimensions must be the same size as in the input tensor, i.e. remapping is only performed within the XY-plane.
65      * @param[in]  policy           The interpolation type.
66      * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
67      */
68     void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *map_x, const ICLTensor *map_y, ICLTensor *output, InterpolationPolicy policy, bool border_undefined);
69 
70     // Inherited methods overridden:
71     void run(const Window &window, cl::CommandQueue &queue) override;
72     BorderSize border_size() const override;
73 
74 private:
75     const ICLTensor *_input;
76     ICLTensor       *_output;
77     const ICLTensor *_map_x;
78     const ICLTensor *_map_y;
79 };
80 } // namespace arm_compute
81 #endif /*ARM_COMPUTE_CLREMAPKERNEL_H */
82