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_CLHOGGRADIENT_H 25 #define ARM_COMPUTE_CLHOGGRADIENT_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/CL/CLTensor.h" 29 #include "arm_compute/runtime/CL/functions/CLDerivative.h" 30 #include "arm_compute/runtime/IFunction.h" 31 #include "arm_compute/runtime/IMemoryManager.h" 32 #include "arm_compute/runtime/MemoryGroup.h" 33 34 #include <cstdint> 35 #include <memory> 36 37 namespace arm_compute 38 { 39 class CLCompileContext; 40 class CLMagnitudePhaseKernel; 41 class ITensorInfo; 42 /** Basic function to calculate the gradient for HOG. This function calls the following OpenCL kernels: 43 * 44 * -# @ref CLDerivative 45 * -# @ref CLMagnitudePhaseKernel 46 * 47 * @deprecated This function is deprecated and is intended to be removed in 21.05 release 48 * 49 */ 50 class CLHOGGradient : public IFunction 51 { 52 public: 53 /** Default constructor */ 54 CLHOGGradient(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 55 /** Initialise the function's source, destinations, phase type and border mode 56 * 57 * @param[in, out] input Input tensor. Data type supported: U8. 58 * (Written to only for @p border_mode != UNDEFINED) 59 * @param[out] output_magnitude Output tensor (magnitude). Data type supported: U16. 60 * @param[out] output_phase Output tensor.(phase). Format supported: U8 61 * @param[in] phase_type Type of @ref PhaseType 62 * @param[in] border_mode Border mode to use 63 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 64 */ 65 void configure(ICLTensor *input, ICLTensor *output_magnitude, ICLTensor *output_phase, PhaseType phase_type, BorderMode border_mode, uint8_t constant_border_value = 0); 66 /** Initialise the function's source, destinations, phase type and border mode 67 * 68 * @param[in] compile_context The compile context to be used. 69 * @param[in, out] input Input tensor. Data type supported: U8. 70 * (Written to only for @p border_mode != UNDEFINED) 71 * @param[out] output_magnitude Output tensor (magnitude). Data type supported: U16. 72 * @param[out] output_phase Output tensor.(phase). Format supported: U8 73 * @param[in] phase_type Type of @ref PhaseType 74 * @param[in] border_mode Border mode to use 75 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 76 */ 77 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output_magnitude, ICLTensor *output_phase, PhaseType phase_type, BorderMode border_mode, 78 uint8_t constant_border_value = 0); 79 80 // Inherited method overridden: 81 void run() override; 82 83 private: 84 MemoryGroup _memory_group; 85 CLDerivative _derivative; 86 std::unique_ptr<CLMagnitudePhaseKernel> _mag_phase; 87 CLTensor _gx; 88 CLTensor _gy; 89 }; 90 } 91 #endif /*ARM_COMPUTE_CLHOGGRADIENT_H */ 92