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_CLHISTOGRAM_H 25 #define ARM_COMPUTE_CLHISTOGRAM_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 #include "src/core/CL/kernels/CLHistogramKernel.h" 29 30 namespace arm_compute 31 { 32 class ICLDistribution1D; 33 class ICLTensor; 34 35 /** Basic function to execute histogram. This function calls the following OpenCL kernels: 36 * 37 * -# @ref CLHistogramKernel 38 * -# @ref CLHistogramBorderKernel 39 * 40 * @deprecated This function is deprecated and is intended to be removed in 21.05 release 41 * 42 */ 43 class CLHistogram : public IFunction 44 { 45 public: 46 /* 47 * @ Default constructor 48 */ 49 CLHistogram(); 50 /** Prevent instances of this class from being copied (As this class contains pointers) */ 51 CLHistogram(const CLHistogram &) = delete; 52 /** Prevent instances of this class from being copied (As this class contains pointers) */ 53 const CLHistogram &operator=(const CLHistogram &) = delete; 54 /** Initialize the function 55 * 56 * @param[in] input Source image. Data types supported: U8 57 * @param[out] output Output distribution. 58 */ 59 void configure(const ICLImage *input, ICLDistribution1D *output); 60 /** Initialize the function 61 * 62 * @param[in] compile_context The compile context to be used. 63 * @param[in] input Source image. Data types supported: U8 64 * @param[out] output Output distribution. 65 */ 66 void configure(const CLCompileContext &compile_context, const ICLImage *input, ICLDistribution1D *output); 67 68 // Inherited methods overridden: 69 void run() override; 70 71 private: 72 CLHistogramKernel _kernel; /**< kernel to run */ 73 CLHistogramBorderKernel _kernel_border; /**< Border kernel to run */ 74 }; 75 } 76 #endif /*ARM_COMPUTE_CLHISTOGRAM_H */ 77