aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/core/CL/kernels/CLSobel5x5Kernel.h
blob: 82831ed14dd28d5e04d0147f9782c72b8acd029a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 * Copyright (c) 2016-2020 Arm Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef ARM_COMPUTE_CLSOBEL5X5KERNEL_H
#define ARM_COMPUTE_CLSOBEL5X5KERNEL_H

#include "arm_compute/core/CL/ICLKernel.h"

namespace arm_compute
{
class ICLTensor;

/** Interface for the kernel to run the horizontal pass of 5x5 Sobel filter on a tensor. */
class CLSobel5x5HorKernel : public ICLKernel
{
public:
    /** Default constructor: initialize all the pointers to nullptr and parameters to zero. */
    CLSobel5x5HorKernel();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLSobel5x5HorKernel(const CLSobel5x5HorKernel &) = delete;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLSobel5x5HorKernel &operator=(const CLSobel5x5HorKernel &) = delete;
    /** Allow instances of this class to be moved */
    CLSobel5x5HorKernel(CLSobel5x5HorKernel &&) = default;
    /** Allow instances of this class to be moved */
    CLSobel5x5HorKernel &operator=(CLSobel5x5HorKernel &&) = default;
    /** Default destructor */
    ~CLSobel5x5HorKernel() = default;

    /** Initialise the kernel's source, destination and border.
     *
     * @note At least one of output_x or output_y must be set.
     *
     * @param[in]  input            Source tensor. Data types supported: U8.
     * @param[out] output_x         (Optional) Destination tensor for the X gradient, Data types supported: S16.
     * @param[out] output_y         (Optional) Destination tensor for the Y gradient, Data types supported: S16.
     * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
     */
    void configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined);
    /** Initialise the kernel's source, destination and border.
     *
     * @note At least one of output_x or output_y must be set.
     *
     * @param[in]  compile_context  The compile context to be used.
     * @param[in]  input            Source tensor. Data types supported: U8.
     * @param[out] output_x         (Optional) Destination tensor for the X gradient, Data types supported: S16.
     * @param[out] output_y         (Optional) Destination tensor for the Y gradient, Data types supported: S16.
     * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined);

    // Inherited methods overridden:
    void run(const Window &window, cl::CommandQueue &queue) override;
    BorderSize border_size() const override;

private:
    const ICLTensor *_input;       /**< Input tensor */
    ICLTensor       *_output_x;    /**< X output of horizontal pass */
    ICLTensor       *_output_y;    /**< Y output of horizontal pass */
    bool             _run_sobel_x; /**< Do we need to run Sobel X ? */
    bool             _run_sobel_y; /**< Do we need to run Sobel Y ? */
    BorderSize       _border_size; /**< Border size */
};

/** Interface for the kernel to run the vertical pass of 5x5 Sobel filter on a tensor. */
class CLSobel5x5VertKernel : public ICLKernel
{
public:
    /** Default constructor: initialize all the pointers to nullptr and parameters to zero. */
    CLSobel5x5VertKernel();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLSobel5x5VertKernel(const CLSobel5x5VertKernel &) = delete;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLSobel5x5VertKernel &operator=(const CLSobel5x5VertKernel &) = delete;
    /** Allow instances of this class to be moved */
    CLSobel5x5VertKernel(CLSobel5x5VertKernel &&) = default;
    /** Allow instances of this class to be moved */
    CLSobel5x5VertKernel &operator=(CLSobel5x5VertKernel &&) = default;
    /** Default destructor */
    ~CLSobel5x5VertKernel() = default;

    /** Initialise the kernel's source, destination and border.
     *
     * @note At least one of output_x or output_y must be set and the corresponding input.
     *
     * @param[in]  input_x          (Optional) Input for X (X output of horizontal pass). Data types supported: S16.
     * @param[in]  input_y          (Optional) Input for Y (Y output of horizontal pass). Data types supported: S16.
     * @param[out] output_x         (Optional) Destination tensor for the X gradient, Data types supported: S16.
     * @param[out] output_y         (Optional) Destination tensor for the Y gradient, Data types supported: S16.
     * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
     */
    void configure(const ICLTensor *input_x, const ICLTensor *input_y, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined);
    /** Initialise the kernel's source, destination and border.
     *
     * @note At least one of output_x or output_y must be set and the corresponding input.
     *
     * @param[in]  compile_context  The compile context to be used.
     * @param[in]  input_x          (Optional) Input for X (X output of horizontal pass). Data types supported: S16.
     * @param[in]  input_y          (Optional) Input for Y (Y output of horizontal pass). Data types supported: S16.
     * @param[out] output_x         (Optional) Destination tensor for the X gradient, Data types supported: S16.
     * @param[out] output_y         (Optional) Destination tensor for the Y gradient, Data types supported: S16.
     * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input_x, const ICLTensor *input_y, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined);

    // Inherited methods overridden:
    void run(const Window &window, cl::CommandQueue &queue) override;
    BorderSize border_size() const override;

private:
    const ICLTensor *_input_x;     /**< X input (X output of the horizontal pass) */
    const ICLTensor *_input_y;     /**< Y input (Y output of the horizontal pass) */
    ICLTensor       *_output_x;    /**< X output of sobel */
    ICLTensor       *_output_y;    /**< Y output of sobel */
    bool             _run_sobel_x; /**< Do we need to run sobel X? */
    bool             _run_sobel_y; /**< Do we need to run sobel Y? */
};
} // namespace arm_compute
#endif /*ARM_COMPUTE_CLSOBEL5X5KERNEL_H */