Compute Library
 21.02
NESobel5x5.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_NESOBEL5x5_H
25 #define ARM_COMPUTE_NESOBEL5x5_H
26 
27 #include "arm_compute/core/Types.h"
32 
33 #include <cstdint>
34 #include <memory>
35 
36 namespace arm_compute
37 {
38 class ITensor;
39 class NESobel5x5HorKernel;
40 class NESobel5x5VertKernel;
41 class NEFillBorderKernel;
42 
43 /** Basic function to execute sobel 5x5 filter. This function calls the following Neon kernels:
44  *
45  * -# @ref NEFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
46  * -# @ref NESobel5x5HorKernel
47  * -# @ref NESobel5x5VertKernel
48  *
49  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
50  *
51  */
52 class NESobel5x5 : public IFunction
53 {
54 public:
55  /** Default constructor */
56  NESobel5x5(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
57  /** Prevent instances of this class from being copied (As this class contains pointers) */
58  NESobel5x5(const NESobel5x5 &) = delete;
59  /** Prevent instances of this class from being copied (As this class contains pointers) */
60  NESobel5x5 &operator=(const NESobel5x5 &) = delete;
61  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
62  NESobel5x5(NESobel5x5 &&) = delete;
63  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
64  NESobel5x5 &operator=(NESobel5x5 &&) = delete;
65  /** Default destructor */
66  ~NESobel5x5();
67  /** Initialise the function's source, destinations and border mode.
68  *
69  * @note At least one of output_x or output_y must be not NULL.
70  *
71  * @param[in, out] input Source tensor. Data type supported: U8. (Written to only for @p border_mode != UNDEFINED)
72  * @param[out] output_x (optional) Destination for the Sobel 5x5 convolution along the X axis. Data type supported: S16.
73  * @param[out] output_y (optional) Destination for the Sobel 5x5 convolution along the Y axis. Data type supported: S16.
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(ITensor *input, ITensor *output_x, ITensor *output_y, BorderMode border_mode, uint8_t constant_border_value = 0);
79 
80  // Inherited methods overridden:
81  void run() override;
82 
83 protected:
84  MemoryGroup _memory_group; /**< Function memory group */
85  std::unique_ptr<NESobel5x5HorKernel> _sobel_hor; /**< Sobel Horizontal 5x5 kernel */
86  std::unique_ptr<NESobel5x5VertKernel> _sobel_vert; /**< Sobel Vertical 5x5 kernel */
87  Tensor _tmp_x; /**< Temporary buffer for Sobel X */
88  Tensor _tmp_y; /**< Temporary buffer for Sobel Y */
89  std::unique_ptr<NEFillBorderKernel> _border_handler; /**< Kernel to handle tensor borders */
90 };
91 }
92 #endif /*ARM_COMPUTE_NESOBEL5x5_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:265
Base class for all functions.
Definition: IFunction.h:30
~NESobel5x5()
Default destructor.
Basic function to execute sobel 5x5 filter.
Definition: NESobel5x5.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
NESobel5x5 & operator=(const NESobel5x5 &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
NESobel5x5(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default constructor.
Definition: NESobel5x5.cpp:39
Basic implementation of the tensor interface.
Definition: Tensor.h:37
void configure(ITensor *input, ITensor *output_x, ITensor *output_y, BorderMode border_mode, uint8_t constant_border_value=0)
Initialise the function&#39;s source, destinations and border mode.
Definition: NESobel5x5.cpp:44
void run() override
Run the kernels contained in the function.
Definition: NESobel5x5.cpp:88