• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2016-2020 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_CLHISTOGRAMKERNEL_H
25 #define ARM_COMPUTE_CLHISTOGRAMKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLDistribution1D;
32 class ICLTensor;
33 using ICLImage = ICLTensor;
34 
35 /** Interface to run the histogram kernel. This kernel processes the part of image with width can be divided by 16.
36  *  If the image width is not a multiple of 16, remaining pixels have to be processed with the @ref CLHistogramBorderKernel
37  */
38 class CLHistogramKernel : public ICLKernel
39 {
40 public:
41     /** Constructor */
42     CLHistogramKernel();
43     /** Prevent instances of this class from being copied (As this class contains pointers) */
44     CLHistogramKernel(const CLHistogramKernel &) = delete;
45     /** Prevent instances of this class from being copied (As this class contains pointers) */
46     CLHistogramKernel &operator=(const CLHistogramKernel &) = delete;
47     /** Allow instances of this class to be moved */
48     CLHistogramKernel(CLHistogramKernel &&) = default;
49     /** Allow instances of this class to be moved */
50     CLHistogramKernel &operator=(CLHistogramKernel &&) = default;
51     /** Initialise the kernel's input, output and border mode.
52      *
53      * @param[in]  input  Source image. Data types supported: U8.
54      * @param[out] output Destination distribution.
55      */
56     void configure(const ICLImage *input, ICLDistribution1D *output);
57     /** Initialise the kernel's input, output and border mode.
58      *
59      * @param[in]  compile_context The compile context to be used.
60      * @param[in]  input           Source image. Data types supported: U8.
61      * @param[out] output          Destination distribution.
62      */
63     void configure(const CLCompileContext &compile_context, const ICLImage *input, ICLDistribution1D *output);
64 
65     // Inherited methods overridden:
66     void run(const Window &window, cl::CommandQueue &queue) override;
67 
68 private:
69     const ICLImage    *_input;
70     ICLDistribution1D *_output;
71 };
72 
73 /** Interface to run the histogram kernel to handle the leftover part of image
74  *
75  */
76 class CLHistogramBorderKernel : public ICLKernel
77 {
78 public:
79     /** Constructor */
80     CLHistogramBorderKernel();
81     /** Prevent instances of this class from being copied (As this class contains pointers) */
82     CLHistogramBorderKernel(const CLHistogramBorderKernel &) = delete;
83     /** Prevent instances of this class from being copied (As this class contains pointers) */
84     CLHistogramBorderKernel &operator=(const CLHistogramBorderKernel &) = delete;
85     /** Allow instances of this class to be moved */
86     CLHistogramBorderKernel(CLHistogramBorderKernel &&) = default;
87     /** Allow instances of this class to be moved */
88     CLHistogramBorderKernel &operator=(CLHistogramBorderKernel &&) = default;
89     /** Initialise the kernel's input, output and border mode.
90      *
91      * @param[in]  input  Source image. Data types supported: U8.
92      * @param[out] output Destination distribution.
93      */
94     void configure(const ICLImage *input, ICLDistribution1D *output);
95     /** Initialise the kernel's input, output and border mode.
96      *
97      * @param[in]  compile_context The compile context to be used.
98      * @param[in]  input           Source image. Data types supported: U8.
99      * @param[out] output          Destination distribution.
100      */
101     void configure(const CLCompileContext &compile_context, const ICLImage *input, ICLDistribution1D *output);
102 
103     // Inherited methods overridden:
104     void run(const Window &window, cl::CommandQueue &queue) override;
105 
106 private:
107     const ICLImage    *_input;
108     ICLDistribution1D *_output;
109 };
110 } // namespace arm_compute
111 #endif /* ARM_COMPUTE_CLHISTOGRAMKERNEL_H*/
112