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_CLSCHARR3X3KERNEL_H 25 #define ARM_COMPUTE_CLSCHARR3X3KERNEL_H 26 27 #include "src/core/CL/ICLKernel.h" 28 29 namespace arm_compute 30 { 31 class ICLTensor; 32 33 /** Interface for the kernel to run a 3x3 Scharr filter on a tensor. 34 * 35 * @f[ 36 * \mathbf{G}_x=\begin{vmatrix} 37 * -3 & 0 & +3\\ 38 * -10& 0 & +10\\ 39 * -3 & 0 & +3 40 * \end{vmatrix} 41 * @f] 42 * @f[ 43 * \mathbf{G}_y=\begin{vmatrix} 44 * -3 & -10 & -3\\ 45 * 0 & 0 & 0\\ 46 * +3 & +10 & +3 47 * \end{vmatrix} 48 * @f] 49 */ 50 class CLScharr3x3Kernel : public ICLKernel 51 { 52 public: 53 /** Default constructor: initialize all the pointers to nullptr and parameters to zero. */ 54 CLScharr3x3Kernel(); 55 /** Prevent instances of this class from being copied (As this class contains pointers) */ 56 CLScharr3x3Kernel(const CLScharr3x3Kernel &) = delete; 57 /** Prevent instances of this class from being copied (As this class contains pointers) */ 58 CLScharr3x3Kernel &operator=(const CLScharr3x3Kernel &) = delete; 59 /** Allow instances of this class to be moved */ 60 CLScharr3x3Kernel(CLScharr3x3Kernel &&) = default; 61 /** Allow instances of this class to be moved */ 62 CLScharr3x3Kernel &operator=(CLScharr3x3Kernel &&) = default; 63 /** Initialise the kernel's source, destination and border. 64 * 65 * @note At least one of output_x or output_y must be set. 66 * 67 * @param[in] input Source tensor. Data types supported: U8. 68 * @param[out] output_x (Optional) Destination tensor for the X gradient, Data types supported: S16. 69 * @param[out] output_y (Optional) Destination tensor for the Y gradient, Data types supported: S16. 70 * @param[in] border_undefined True if the border mode is undefined. False if it's replicate or constant. 71 */ 72 void configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined); 73 /** Initialise the kernel's source, destination and border. 74 * 75 * @note At least one of output_x or output_y must be set. 76 * 77 * @param[in] compile_context The compile context to be used. 78 * @param[in] input Source tensor. Data types supported: U8. 79 * @param[out] output_x (Optional) Destination tensor for the X gradient, Data types supported: S16. 80 * @param[out] output_y (Optional) Destination tensor for the Y gradient, Data types supported: S16. 81 * @param[in] border_undefined True if the border mode is undefined. False if it's replicate or constant. 82 */ 83 void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined); 84 85 // Inherited methods overridden: 86 void run(const Window &window, cl::CommandQueue &queue) override; 87 BorderSize border_size() const override; 88 89 private: 90 bool _run_scharr_x; /**< Do we need to run Scharr X ? */ 91 bool _run_scharr_y; /**< Do we need to run Scharr Y ? */ 92 const ICLTensor *_input; /**< Input image */ 93 ICLTensor *_output_x; /**< Output image for scharr X */ 94 ICLTensor *_output_y; /**< Output image for scharr Y */ 95 }; 96 } // namespace arm_compute 97 #endif /*ARM_COMPUTE_CLSCHARR3X3KERNEL_H */ 98