Compute Library
 21.02
NEFillBorderKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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_NEFILLBORDERKERNEL_H
25 #define ARM_COMPUTE_NEFILLBORDERKERNEL_H
26 
28 #include "arm_compute/core/Types.h"
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class ITensor;
35 
36 /** Interface for the kernel to fill borders */
38 {
39 public:
40  const char *name() const override
41  {
42  return "NEFillBorderKernel";
43  }
44  /** Default Constructor */
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  NEFillBorderKernel(const NEFillBorderKernel &) = delete;
48  /** Prevent instances of this class from being copied (As this class contains pointers) */
50  /** Allow instances of this class to be moved */
52  /** Allow instances of this class to be moved */
54  /** Default destructor */
55  ~NEFillBorderKernel() = default;
56 
57  /** Initialise the function.
58  *
59  * @note This kernel fills the borders within the XY-planes.
60  *
61  * @param[in,out] tensor Tensor to process. Data types supported: All.
62  * @param[in] border_size Size of the border to fill in elements.
63  * @param[in] border_mode Border mode to use for the convolution.
64  * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
65  *
66  */
67  void configure(ITensor *tensor, BorderSize border_size, BorderMode border_mode, const PixelValue &constant_border_value = PixelValue());
68  /** Initialise the function.
69  *
70  * @note This kernel fills the borders within the XY-planes.
71  *
72  * @param[in,out] tensor Tensor info to process. Data types supported: All.
73  * @param[in] border_size Size of the border to fill in elements.
74  * @param[in] border_mode Border mode to use for the convolution.
75  * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
76  *
77  */
78  void configure(ITensorInfo *tensor, BorderSize border_size, BorderMode border_mode, const PixelValue &constant_border_value = PixelValue());
79 
80  // Inherited methods overridden:
81  void run(const Window &window, const ThreadInfo &info) override;
82  void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
83 
84 private:
85  void fill_replicate_single_channel(const Window &window);
86  void fill_constant_value_single_channel(const Window &window);
87 
88  ITensor *_tensor;
89  BorderSize _border_size;
90  BorderMode _mode;
91  PixelValue _constant_border_value;
92 };
93 } // namespace arm_compute
94 #endif /*ARM_COMPUTE_NEFILLBORDERKERNEL_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:265
NEFillBorderKernel()
Default Constructor.
Class describing the value of a pixel for any image format.
Definition: PixelValue.h:34
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
const char * name() const override
Name of the kernel.
Container for 2D border size.
Definition: Types.h:273
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor's metadata.
Definition: ITensorInfo.h:40
void configure(ITensor *tensor, BorderSize border_size, BorderMode border_mode, const PixelValue &constant_border_value=PixelValue())
Initialise the function.
NEFillBorderKernel & operator=(const NEFillBorderKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
virtual BorderSize border_size() const
The size of the border for that kernel.
Definition: IKernel.cpp:46
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
~NEFillBorderKernel()=default
Default destructor.
Information about executing thread and CPU.
Definition: CPPTypes.h:235
Interface for the kernel to fill borders.
Tensor packing service.
Definition: ITensorPack.h:37
Describe a multidimensional execution window.
Definition: Window.h:39