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_NEMEANSTDDEV_H 25 #define ARM_COMPUTE_NEMEANSTDDEV_H 26 27 #include "arm_compute/core/IMultiImage.h" 28 #include "arm_compute/core/Types.h" 29 #include "arm_compute/runtime/IFunction.h" 30 #include <memory> 31 32 #include <cstdint> 33 34 namespace arm_compute 35 { 36 class NEMeanStdDevKernel; 37 class NEFillBorderKernel; 38 39 /** Basic function to execute mean and std deviation. This function calls the following NEON kernels: 40 * 41 * @ref NEMeanStdDevKernel 42 * 43 */ 44 class NEMeanStdDev : public IFunction 45 { 46 public: 47 /** Default Constructor. */ 48 NEMeanStdDev(); 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NEMeanStdDev(const NEMeanStdDev &) = delete; 51 /** Prevent instances of this class from being copied (As this class contains pointers) */ 52 NEMeanStdDev &operator=(const NEMeanStdDev &) = delete; 53 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 54 NEMeanStdDev(NEMeanStdDev &&) = delete; 55 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 56 NEMeanStdDev &operator=(NEMeanStdDev &&) = delete; 57 /** Default destructor */ 58 ~NEMeanStdDev(); 59 /** Initialise the kernel's inputs and outputs. 60 * 61 * @param[in, out] input Input image. Data types supported: U8. (Written to only for border filling) 62 * @param[out] mean Output average pixel value. 63 * @param[out] stddev (Optional) Output standard deviation of pixel values. 64 */ 65 void configure(IImage *input, float *mean, float *stddev = nullptr); 66 67 // Inherited methods overridden: 68 void run() override; 69 70 private: 71 std::unique_ptr<NEMeanStdDevKernel> _mean_stddev_kernel; /**< Kernel that standard deviation calculation. */ 72 std::unique_ptr<NEFillBorderKernel> _fill_border_kernel; /**< Kernel that fills tensor's borders with zeroes. */ 73 uint64_t _global_sum; /**< Variable that holds the global sum among calls in order to ease reduction */ 74 uint64_t _global_sum_squared; /**< Variable that holds the global sum of squared values among calls in order to ease reduction */ 75 }; 76 } 77 #endif /*ARM_COMPUTE_NEMEANSTDDEV_H */ 78