Compute Library
 21.02
NEHistogram.h
Go to the documentation of this file.
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_NEHISTOGRAM_H
25 #define ARM_COMPUTE_NEHISTOGRAM_H
26 
28 
29 #include <cstddef>
30 #include <cstdint>
31 #include <memory>
32 #include <vector>
33 
34 namespace arm_compute
35 {
36 class ITensor;
37 class IDistribution1D;
38 class NEHistogramKernel;
39 using IImage = ITensor;
40 
41 /** Basic function to run @ref NEHistogramKernel.
42  *
43  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
44  *
45  */
46 class NEHistogram : public IFunction
47 {
48 public:
49  /** Default Constructor. */
50  NEHistogram();
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  NEHistogram(const NEHistogram &) = delete;
53  /** Prevent instances of this class from being copied (As this class contains pointers) */
54  NEHistogram &operator=(const NEHistogram &) = delete;
55  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
56  NEHistogram(NEHistogram &&) = delete;
57  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
58  NEHistogram &operator=(NEHistogram &&) = delete;
59  /** Default destructor */
60  ~NEHistogram();
61  /** Initialise the kernel's inputs.
62  *
63  * @param[in] input Input image. Data type supported: U8.
64  * @param[out] output Output distribution.
65  */
66  void configure(const IImage *input, IDistribution1D *output);
67 
68  // Inherited methods overridden:
69  void run() override;
70 
71 private:
72  std::unique_ptr<NEHistogramKernel> _histogram_kernel;
73  std::vector<uint32_t> _local_hist;
74  std::vector<uint32_t> _window_lut;
75  size_t _local_hist_size;
76  /** 256 possible pixel values as we handle only U8 images */
77  static constexpr unsigned int window_lut_default_size = 256;
78 };
79 }
80 #endif /*ARM_COMPUTE_NEHISTOGRAM_H */
NEHistogram()
Default Constructor.
Definition: NEHistogram.cpp:38
Base class for all functions.
Definition: IFunction.h:30
Interface for Neon tensor.
Definition: ITensor.h:36
void configure(const IImage *input, IDistribution1D *output)
Initialise the kernel&#39;s inputs.
Definition: NEHistogram.cpp:43
Copyright (c) 2017-2021 Arm Limited.
Basic function to run NEHistogramKernel.
Definition: NEHistogram.h:46
1D Distribution interface
void run() override
Run the kernels contained in the function.
Definition: NEHistogram.cpp:57
~NEHistogram()
Default destructor.
ITensor IImage
Interface for CPP Images.
NEHistogram & operator=(const NEHistogram &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...