Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michalis Spyrou | d1794eb | 2018-06-15 16:15:26 +0100 | [diff] [blame] | 2 | * Copyright (c) 2016-2018 ARM Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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_CLMEANSTDDEVKERNEL_H__ |
| 25 | #define __ARM_COMPUTE_CLMEANSTDDEVKERNEL_H__ |
| 26 | |
| 27 | #include "arm_compute/core/CL/ICLKernel.h" |
| 28 | |
| 29 | namespace cl |
| 30 | { |
| 31 | class Buffer; |
| 32 | } |
| 33 | |
| 34 | namespace arm_compute |
| 35 | { |
| 36 | class ICLTensor; |
| 37 | using ICLImage = ICLTensor; |
| 38 | |
| 39 | /** Interface for the kernel to calculate mean and standard deviation of input image pixels. */ |
| 40 | class CLMeanStdDevKernel : public ICLKernel |
| 41 | { |
| 42 | public: |
| 43 | /** Default constructor */ |
| 44 | CLMeanStdDevKernel(); |
| 45 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 46 | CLMeanStdDevKernel(const CLMeanStdDevKernel &) = delete; |
| 47 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 48 | CLMeanStdDevKernel &operator=(const CLMeanStdDevKernel &) = delete; |
| 49 | /** Allow instances of this class to be moved */ |
| 50 | CLMeanStdDevKernel(CLMeanStdDevKernel &&) = default; |
| 51 | /** Allow instances of this class to be moved */ |
| 52 | CLMeanStdDevKernel &operator=(CLMeanStdDevKernel &&) = default; |
| 53 | /** Initialise the kernel's input and outputs. |
| 54 | * |
| 55 | * @param[in] input Input image. Data types supported: U8. |
| 56 | * @param[out] mean Input average pixel value. |
| 57 | * @param[out] global_sum Keeps global sum of pixel values (Buffer size: 1 cl_ulong). |
| 58 | * @param[out] stddev (Optional) Output standard deviation of pixel values. |
| 59 | * @param[out] global_sum_squared (Optional if stddev is not set, required if stddev is set) Keeps global sum of squared pixel values (Buffer size: 1 cl_ulong). |
| 60 | */ |
| 61 | void configure(const ICLImage *input, float *mean, cl::Buffer *global_sum, float *stddev = nullptr, cl::Buffer *global_sum_squared = nullptr); |
Michalis Spyrou | d1794eb | 2018-06-15 16:15:26 +0100 | [diff] [blame] | 62 | /** Static function to check if given info will lead to a valid configuration of @ref CLMeanStdDevKernel. |
| 63 | * |
| 64 | * @param[in] input Input image info. Data types supported: U8. |
| 65 | * @param[in] mean Input average pixel value. |
| 66 | * @param[in] global_sum Keeps global sum of pixel values. |
| 67 | * @param[in] stddev (Optional) Output standard deviation of pixel values. |
| 68 | * @param[in] global_sum_squared (Optional if stddev is not set, required if stddev is set) Keeps global sum of squared pixel values. |
| 69 | * |
| 70 | * @return a status |
| 71 | */ |
| 72 | static Status validate(const ITensorInfo *input, float *mean, cl::Buffer *global_sum, float *stddev = nullptr, cl::Buffer *global_sum_squared = nullptr); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 73 | |
| 74 | // Inherited methods overridden: |
| 75 | void run(const Window &window, cl::CommandQueue &queue) override; |
| 76 | |
Giorgio Arena | a261181 | 2017-07-21 10:08:48 +0100 | [diff] [blame] | 77 | BorderSize border_size() const override; |
| 78 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 79 | private: |
| 80 | const ICLImage *_input; |
| 81 | float *_mean; |
| 82 | float *_stddev; |
| 83 | cl::Buffer *_global_sum; |
| 84 | cl::Buffer *_global_sum_squared; |
Giorgio Arena | a261181 | 2017-07-21 10:08:48 +0100 | [diff] [blame] | 85 | BorderSize _border_size; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 86 | }; |
Gian Marco Iodice | f670a0a | 2017-09-18 12:20:45 +0100 | [diff] [blame] | 87 | } // namespace arm_compute |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 88 | #endif /* __ARM_COMPUTE_CLMEANSTDDEVKERNEL_H__ */ |