Compute Library
 21.02
NEEqualizeHistogram.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_NEEQUALIZEHISTOGRAM_H
25 #define ARM_COMPUTE_NEEQUALIZEHISTOGRAM_H
26 
30 
31 #include <cstdint>
32 
33 namespace arm_compute
34 {
35 class ITensor;
36 class NEHistogramKernel;
37 class NECumulativeDistributionKernel;
38 class NETableLookupKernel;
39 using IImage = ITensor;
40 
41 /** Basic function to execute histogram equalization. This function calls the following Neon kernels:
42  *
43  * -# @ref NEHistogramKernel
44  * -# @ref NECumulativeDistributionKernel
45  * -# @ref NETableLookupKernel
46  *
47  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
48  *
49  */
51 {
52 public:
53  /** Default Constructor. */
55  /** Prevent instances of this class from being copied (As this class contains pointers) */
56  NEEqualizeHistogram(const NEEqualizeHistogram &) = delete;
57  /** Prevent instances of this class from being copied (As this class contains pointers) */
59  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
61  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
63  /** Default destructor */
65  /** Initialise the kernel's inputs.
66  *
67  * @note Currently the width of the input image must be a multiple of 16.
68  *
69  * @param[in] input Input image. Data type supported: U8.
70  * @param[out] output Output image. Data type supported: same as @p input
71  */
72  void configure(const IImage *input, IImage *output);
73 
74  // Inherited methods overridden:
75  void run() override;
76 
77 private:
78  std::unique_ptr<NEHistogramKernel> _histogram_kernel; /**< Kernel that calculates the histogram of input. */
79  std::unique_ptr<NECumulativeDistributionKernel> _cd_histogram_kernel; /**< Kernel that calculates the cumulative distribution
80  and creates the relevant LookupTable. */
81  std::unique_ptr<NETableLookupKernel> _map_histogram_kernel; /**< Kernel that maps the input to output using the lut. */
82  Distribution1D _hist; /**< Distribution that holds the histogram of the input image. */
83  Distribution1D _cum_dist; /**< Distribution that holds the cummulative distribution of the input histogram. */
84  Lut _cd_lut; /**< Holds the equalization lookuptable. */
85  static constexpr uint32_t nr_bins{ 256 }; /**< Histogram bins of the internal histograms. */
86  static constexpr uint32_t max_range{ nr_bins - 1 }; /**< Histogram range of the internal histograms. */
87 };
88 }
89 #endif /*ARM_COMPUTE_NEEQUALIZEHISTOGRAM_H */
~NEEqualizeHistogram()
Default destructor.
void run() override
Run the kernels contained in the function.
Base class for all functions.
Definition: IFunction.h:30
void configure(const IImage *input, IImage *output)
Initialise the kernel&#39;s inputs.
Interface for Neon tensor.
Definition: ITensor.h:36
Basic implementation of the LUT interface.
Definition: Lut.h:39
Copyright (c) 2017-2021 Arm Limited.
NEEqualizeHistogram()
Default Constructor.
NEEqualizeHistogram & operator=(const NEEqualizeHistogram &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
ITensor IImage
Interface for CPP Images.
Basic function to execute histogram equalization.
Basic implementation of the 1D distribution interface.