1 /* 2 * Copyright (c) 2017-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_CLGAUSSIANPYRAMID_H 25 #define ARM_COMPUTE_CLGAUSSIANPYRAMID_H 26 27 #include "arm_compute/core/IPyramid.h" 28 #include "arm_compute/core/Types.h" 29 #include "arm_compute/runtime/CL/CLPyramid.h" 30 #include "arm_compute/runtime/CL/functions/CLGaussian5x5.h" 31 #include "arm_compute/runtime/IFunction.h" 32 33 #include <cstdint> 34 #include <memory> 35 36 namespace arm_compute 37 { 38 class CLCompileContext; 39 class CLFillBorderKernel; 40 class ICLTensor; 41 class CLGaussianPyramidHorKernel; 42 class CLGaussianPyramidVertKernel; 43 class CLScaleKernel; 44 45 /** Common interface for all Gaussian pyramid functions 46 * 47 * @deprecated This function is deprecated and is intended to be removed in 21.05 release 48 * 49 */ 50 class CLGaussianPyramid : public IFunction 51 { 52 public: 53 /** Constructor */ 54 CLGaussianPyramid(); 55 /** Prevent instances of this class from being copied (As this class contains pointers) */ 56 CLGaussianPyramid(const CLGaussianPyramid &) = delete; 57 /** Prevent instances of this class from being copied (As this class contains pointers) */ 58 CLGaussianPyramid &operator=(const CLGaussianPyramid &) = delete; 59 /** Allow instances of this class to be moved */ 60 CLGaussianPyramid(CLGaussianPyramid &&) = default; 61 /** Allow instances of this class to be moved */ 62 CLGaussianPyramid &operator=(CLGaussianPyramid &&) = default; 63 /** Default destructor */ 64 ~CLGaussianPyramid(); 65 /** Initialise the function's source, destinations and border mode. 66 * 67 * @param[in, out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) 68 * @param[out] pyramid Destination pyramid tensors, Data types supported at each level: U8. 69 * @param[in] border_mode Border mode to use. 70 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 71 * 72 */ 73 virtual void configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value = 0) = 0; 74 /** Initialise the function's source, destinations and border mode. 75 * 76 * @param[in] compile_context The compile context to be used. 77 * @param[in, out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) 78 * @param[out] pyramid Destination pyramid tensors, Data types supported at each level: U8. 79 * @param[in] border_mode Border mode to use. 80 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 81 * 82 */ 83 virtual void configure(const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value = 0) = 0; 84 85 protected: 86 ICLTensor *_input; 87 CLPyramid *_pyramid; 88 CLPyramid _tmp; 89 }; 90 91 /** Basic function to execute gaussian pyramid with HALF scale factor. This function calls the following OpenCL kernels: 92 * 93 * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) 94 * -# @ref CLGaussianPyramidHorKernel 95 * -# @ref CLGaussianPyramidVertKernel 96 */ 97 class CLGaussianPyramidHalf : public CLGaussianPyramid 98 { 99 public: 100 /** Constructor */ 101 CLGaussianPyramidHalf(); 102 /** Prevent instances of this class from being copied */ 103 CLGaussianPyramidHalf(const CLGaussianPyramidHalf &) = delete; 104 /** Prevent instances of this class from being copied */ 105 CLGaussianPyramidHalf &operator=(const CLGaussianPyramidHalf &) = delete; 106 /** Default destructor */ 107 ~CLGaussianPyramidHalf(); 108 109 // Inherited methods overridden: 110 void configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override; 111 void configure(const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override; 112 void run() override; 113 114 private: 115 std::vector<std::unique_ptr<CLFillBorderKernel>> _horizontal_border_handler; 116 std::vector<std::unique_ptr<CLFillBorderKernel>> _vertical_border_handler; 117 std::vector<std::unique_ptr<CLGaussianPyramidHorKernel>> _horizontal_reduction; 118 std::vector<std::unique_ptr<CLGaussianPyramidVertKernel>> _vertical_reduction; 119 }; 120 121 /** Basic function to execute gaussian pyramid with ORB scale factor. This function calls the following OpenCL kernels and functions: 122 * 123 * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) 124 * -# @ref CLGaussian5x5 125 * -# @ref CLScaleKernel 126 */ 127 class CLGaussianPyramidOrb : public CLGaussianPyramid 128 { 129 public: 130 /** Constructor */ 131 CLGaussianPyramidOrb(); 132 133 // Inherited methods overridden: 134 void configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override; 135 void configure(const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override; 136 void run() override; 137 138 private: 139 std::vector<CLGaussian5x5> _gauss5x5; 140 std::vector<std::unique_ptr<CLScaleKernel>> _scale_nearest; 141 }; 142 } 143 #endif /*ARM_COMPUTE_CLGAUSSIANPYRAMID_H */ 144