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_NEMEANSTDDEVKERNEL_H 25 #define ARM_COMPUTE_NEMEANSTDDEVKERNEL_H 26 27 #include "src/core/NEON/INEKernel.h" 28 #include "support/Mutex.h" 29 30 #include <cstdint> 31 32 namespace arm_compute 33 { 34 class ITensor; 35 using IImage = ITensor; 36 37 /** Interface for the kernel to calculate mean and standard deviation of input image pixels. */ 38 class NEMeanStdDevKernel : public INEKernel 39 { 40 public: name()41 const char *name() const override 42 { 43 return "NEMeanStdDevKernel"; 44 } 45 /** Default constructor */ 46 NEMeanStdDevKernel(); 47 /** Prevent instances of this class from being copied (As this class contains pointers) */ 48 NEMeanStdDevKernel(const NEMeanStdDevKernel &) = delete; 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NEMeanStdDevKernel &operator=(const NEMeanStdDevKernel &) = delete; 51 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 52 NEMeanStdDevKernel(NEMeanStdDevKernel &&) = delete; 53 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 54 NEMeanStdDevKernel &operator=(NEMeanStdDevKernel &&) = delete; 55 /** Default destructor */ 56 ~NEMeanStdDevKernel() = default; 57 58 /** Initialise the kernel's input and outputs. 59 * 60 * @param[in] input Input image. Data type supported: U8. 61 * @param[out] mean Input average pixel value. 62 * @param[out] global_sum Keeps global sum of pixel values. 63 * @param[out] stddev (Optional) Output standard deviation of pixel values. 64 * @param[out] global_sum_squared (Optional if stddev is not set, required if stddev is set) Keeps global sum of squared pixel values. 65 */ 66 void configure(const IImage *input, float *mean, uint64_t *global_sum, float *stddev = nullptr, uint64_t *global_sum_squared = nullptr); 67 68 // Inherited methods overridden: 69 void run(const Window &window, const ThreadInfo &info) override; 70 71 BorderSize border_size() const override; 72 73 private: 74 const IImage *_input; 75 float *_mean; 76 float *_stddev; 77 uint64_t *_global_sum; 78 uint64_t *_global_sum_squared; 79 arm_compute::Mutex _mtx; 80 BorderSize _border_size; 81 }; 82 } // namespace arm_compute 83 #endif /* ARM_COMPUTE_NEMEANSTDDEVKERNEL_H */ 84