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_CLSOBEL7X7_H 25 #define ARM_COMPUTE_CLSOBEL7X7_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/CL/CLTensor.h" 29 #include "arm_compute/runtime/IFunction.h" 30 #include "arm_compute/runtime/IMemoryManager.h" 31 #include "arm_compute/runtime/MemoryGroup.h" 32 33 #include <cstdint> 34 #include <memory> 35 36 namespace arm_compute 37 { 38 class CLCompileContext; 39 class CLFillBorderKernel; 40 class CLSobel7x7HorKernel; 41 class CLSobel7x7VertKernel; 42 class ICLTensor; 43 44 /** Basic function to execute sobel 7x7 filter. This function calls the following OpenCL kernels: 45 * 46 * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) 47 * -# @ref CLSobel7x7HorKernel 48 * -# @ref CLSobel7x7VertKernel 49 * 50 * @deprecated This function is deprecated and is intended to be removed in 21.05 release 51 * 52 */ 53 class CLSobel7x7 : public IFunction 54 { 55 public: 56 /** Default Constructor. 57 * 58 * @param[in] memory_manager (Optional) Memory manager. 59 */ 60 CLSobel7x7(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 61 /** Prevent instances of this class from being copied */ 62 CLSobel7x7(const CLSobel7x7 &) = delete; 63 /** Prevent instances of this class from being copied */ 64 CLSobel7x7 &operator=(const CLSobel7x7 &) = delete; 65 /** Default destructor */ 66 ~CLSobel7x7(); 67 /** Initialise the function's source, destinations and border mode. 68 * 69 * @note At least one of output_x or output_y must be not NULL. 70 * 71 * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) 72 * @param[out] output_x (optional) Destination for the Sobel 7x7 convolution along the X axis. Data types supported: S32. 73 * @param[out] output_y (optional) Destination for the Sobel 7x7 convolution along the Y axis. Data types supported: S32. 74 * @param[in] border_mode Border mode to use for the convolution. 75 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 76 */ 77 void configure(ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, BorderMode border_mode, uint8_t constant_border_value = 0); 78 /** Initialise the function's source, destinations and border mode. 79 * 80 * @note At least one of output_x or output_y must be not NULL. 81 * 82 * @param[in] compile_context The compile context to be used. 83 * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) 84 * @param[out] output_x (optional) Destination for the Sobel 7x7 convolution along the X axis. Data types supported: S32. 85 * @param[out] output_y (optional) Destination for the Sobel 7x7 convolution along the Y axis. Data types supported: S32. 86 * @param[in] border_mode Border mode to use for the convolution. 87 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 88 */ 89 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, BorderMode border_mode, uint8_t constant_border_value = 0); 90 91 // Inherited methods overridden: 92 void run() override; 93 94 protected: 95 MemoryGroup _memory_group; /**< Function's memory group */ 96 std::unique_ptr<CLSobel7x7HorKernel> _sobel_hor; /**< Sobel Horizontal 7x7 kernel */ 97 std::unique_ptr<CLSobel7x7VertKernel> _sobel_vert; /**< Sobel Vertical 7x7 kernel */ 98 std::unique_ptr<CLFillBorderKernel> _border_handler; /**< Kernel to handle image borders */ 99 CLImage _tmp_x; /**< Temporary buffer for Sobel X */ 100 CLImage _tmp_y; /**< Temporary buffer for Sobel Y */ 101 }; 102 } 103 #endif /*ARM_COMPUTE_CLSOBEL7X7_H */ 104