aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/core/CL/kernels/CLFastCornersKernel.h
blob: 5d0da7d5d5a46695054ad4b3e2b975664ef4071f (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
/*
 * 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_CLFASTCORNERSKERNEL_H
#define ARM_COMPUTE_CLFASTCORNERSKERNEL_H

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

#include <cstdint>

namespace cl
{
class Buffer;
}

namespace arm_compute
{
class ICLTensor;
using ICLImage = ICLTensor;

/** CL kernel to perform fast corners */
class CLFastCornersKernel : public ICLKernel
{
public:
    /** Default constructor */
    CLFastCornersKernel();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLFastCornersKernel(const CLFastCornersKernel &) = delete;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLFastCornersKernel &operator=(const CLFastCornersKernel &) = delete;
    /** Allow instances of this class to be moved */
    CLFastCornersKernel(CLFastCornersKernel &&) = default;
    /** Allow instances of this class to be moved */
    CLFastCornersKernel &operator=(CLFastCornersKernel &&) = default;
    /** Default destructor */
    ~CLFastCornersKernel() = default;

    /** Initialise the kernel.
     *
     * @param[in]  input               Source image. Data types supported: U8.
     * @param[out] output              Output image. Data types supported: U8.
     * @param[in]  threshold           Threshold on difference between intensity of the central pixel and pixels on Bresenham's circle of radius 3.
     * @param[in]  non_max_suppression True if non-maxima suppresion is applied, false otherwise.
     * @param[in]  border_mode         Strategy to use for borders.
     */
    void configure(const ICLImage *input, ICLImage *output, float threshold, bool non_max_suppression, BorderMode border_mode);
    /** Initialise the kernel.
     *
     * @param[in]  compile_context     The compile context to be used.
     * @param[in]  input               Source image. Data types supported: U8.
     * @param[out] output              Output image. Data types supported: U8.
     * @param[in]  threshold           Threshold on difference between intensity of the central pixel and pixels on Bresenham's circle of radius 3.
     * @param[in]  non_max_suppression True if non-maxima suppresion is applied, false otherwise.
     * @param[in]  border_mode         Strategy to use for borders.
     */
    void configure(const CLCompileContext &compile_context, const ICLImage *input, ICLImage *output, float threshold, bool non_max_suppression, BorderMode border_mode);

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

private:
    const ICLImage *_input;
    ICLImage       *_output;
};

/** CL kernel to copy keypoints information to ICLKeyPointArray and counts the number of key points */
class CLCopyToArrayKernel : public ICLKernel
{
public:
    /** Default constructor */
    CLCopyToArrayKernel();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLCopyToArrayKernel(const CLCopyToArrayKernel &) = delete;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLCopyToArrayKernel &operator=(const CLCopyToArrayKernel &) = delete;
    /** Allow instances of this class to be moved */
    CLCopyToArrayKernel(CLCopyToArrayKernel &&) = default;
    /** Allow instances of this class to be moved */
    CLCopyToArrayKernel &operator=(CLCopyToArrayKernel &&) = default;
    /** Default destructor */
    ~CLCopyToArrayKernel() = default;

    /** Initialise the kernel.
     *
     * @param[in]  input         Source image. Data types supported: U8.
     * @param[in]  update_number Flag to indicate whether we need to update the number of corners
     * @param[out] corners       Array of keypoints to store the results.
     * @param[out] num_buffers   Number of keypoints to store the results.
     */
    void configure(const ICLImage *input, bool update_number, ICLKeyPointArray *corners, cl::Buffer *num_buffers);
    /** Initialise the kernel.
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Source image. Data types supported: U8.
     * @param[in]  update_number   Flag to indicate whether we need to update the number of corners
     * @param[out] corners         Array of keypoints to store the results.
     * @param[out] num_buffers     Number of keypoints to store the results.
     */
    void configure(const CLCompileContext &compile_context, const ICLImage *input, bool update_number, ICLKeyPointArray *corners, cl::Buffer *num_buffers);

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

private:
    const ICLImage   *_input;      /**< source image */
    ICLKeyPointArray *_corners;    /**< destination array */
    cl::Buffer       *_num_buffer; /**< CL memory to record number of key points in the array */
};
} // namespace arm_compute
#endif /* ARM_COMPUTE_CLFASTCORNERSKERNEL_H */