blob: 4bff8596b8e32212c8927fe4185d695fd93d1450 [file] [log] [blame]
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001/*
2 * Copyright (c) 2016, 2017 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_NESOBEL7x7KERNEL_H__
25#define __ARM_COMPUTE_NESOBEL7x7KERNEL_H__
26
27#include "arm_compute/core/NEON/INEKernel.h"
28
29namespace arm_compute
30{
31class ITensor;
32
33/** Interface for the kernel to run the horizontal pass of 7x7 Sobel filter on a tensor.
34 *
35 */
36class NESobel7x7HorKernel : public INEKernel
37{
38public:
39 /** Default constructor */
40 NESobel7x7HorKernel();
41 /** Prevent instances of this class from being copied (As this class contains pointers) */
42 NESobel7x7HorKernel(const NESobel7x7HorKernel &) = delete;
43 /** Prevent instances of this class from being copied (As this class contains pointers) */
44 NESobel7x7HorKernel &operator=(const NESobel7x7HorKernel &) = delete;
45 /** Allow instances of this class to be moved */
46 NESobel7x7HorKernel(NESobel7x7HorKernel &&) = default;
47 /** Allow instances of this class to be moved */
48 NESobel7x7HorKernel &operator=(NESobel7x7HorKernel &&) = default;
49 /** Default destructor */
50 ~NESobel7x7HorKernel() = default;
51
52 /** Initialise the kernel's source, destination and border mode.
53 *
54 * @note At least one of output_x or output_y must be set.
55 *
56 * @param[in] input Source tensor. Data type supported: U8.
57 * @param[out] output_x (Optional) Destination tensor for the X gradient. Data type supported: S32.
58 * @param[out] output_y (Optional) Destination tensor for the Y gradient. Data type supported: S32.
59 * @param[in] border_undefined True if the border mode is undefined. False if it's replicate or constant.
60 */
61 void configure(const ITensor *input, ITensor *output_x, ITensor *output_y, bool border_undefined);
62
63 // Inherited methods overridden:
64 void run(const Window &window) override;
65 BorderSize border_size() const override;
66
67private:
68 const ITensor *_input; /**< Input tensor */
69 ITensor *_output_x; /**< X output of horizontal pass */
70 ITensor *_output_y; /**< Y output of horizontal pass */
71 bool _run_sobel_x; /**< Do we need to run Sobel X? */
72 bool _run_sobel_y; /**< Do we need to run Sobel Y? */
73 BorderSize _border_size; /**< Border size */
74};
75
76/** Interface for the kernel to run the vertical pass of 7x7 Sobel Y filter on a tensor.
77 *
78*/
79class NESobel7x7VertKernel : public INEKernel
80{
81public:
82 /** Default constructor */
83 NESobel7x7VertKernel();
84 /** Prevent instances of this class from being copied (As this class contains pointers) */
85 NESobel7x7VertKernel(const NESobel7x7VertKernel &) = delete;
86 /** Prevent instances of this class from being copied (As this class contains pointers) */
87 NESobel7x7VertKernel &operator=(const NESobel7x7VertKernel &) = delete;
88 /** Allow instances of this class to be moved */
89 NESobel7x7VertKernel(NESobel7x7VertKernel &&) = default;
90 /** Allow instances of this class to be moved */
91 NESobel7x7VertKernel &operator=(NESobel7x7VertKernel &&) = default;
92 /** Default destructor */
93 ~NESobel7x7VertKernel() = default;
94
95 /** Initialise the kernel's source, destination and border mode.
96 *
97 * @note At least one of output_x or output_y must be set
98 * @note If output_x is set then input_x must be set too
99 * @note If output_y is set then input_y must be set too
100 *
101 * @param[in] input_x (Optional) Input for X (X output of hor pass). Data type supported: S32.
102 * @param[in] input_y (Optional) Input for Y (Y output of hor pass). Data type supported: S32.
103 * @param[out] output_x (Optional) Destination tensor for the X gradient. Data type supported: S32.
104 * @param[out] output_y (Optional) Destination tensor for the Y gradient. Data type supported: S32.
105 * @param[in] border_undefined True if the border mode is undefined. False if it's replicate or constant.
106 */
107 void configure(const ITensor *input_x, const ITensor *input_y, ITensor *output_x, ITensor *output_y, bool border_undefined);
108
109 // Inherited methods overridden:
110 void run(const Window &window) override;
111 BorderSize border_size() const override;
112
113private:
114 const ITensor *_input_x; /**< X input (X output of the hor pass) */
115 const ITensor *_input_y; /**< Y input (Y output of the hor pass) */
116 ITensor *_output_x; /**< X output of sobel */
117 ITensor *_output_y; /**< Y output of sobel */
118 bool _run_sobel_x; /**< Do we need to run sobel X? */
119 bool _run_sobel_y; /**< Do we need to run sobel Y? */
120};
121}
122#endif /*__ARM_COMPUTE_NESOBEL7x7KERNEL_H__ */