Compute Library
 21.02
NEHOGGradient.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2021 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_NEHOGGRADIENT_H
25 #define ARM_COMPUTE_NEHOGGRADIENT_H
26 
27 #include "arm_compute/core/Types.h"
33 
34 #include <cstdint>
35 #include <memory>
36 
37 namespace arm_compute
38 {
39 class ITensor;
40 class ICPPKernel;
41 
42 /** Basic function to calculate the gradient for HOG. This function calls the following Neon kernels:
43  *
44  * -# @ref NEDerivative
45  * -# NEMagnitudePhaseKernel
46  *
47  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
48  *
49  */
50 class NEHOGGradient : public IFunction
51 {
52 public:
53  /** Default constructor */
54  NEHOGGradient(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
55  /** Prevent instances of this class from being copied (As this class contains pointers) */
56  NEHOGGradient(const NEHOGGradient &) = delete;
57  /** Prevent instances of this class from being copied (As this class contains pointers) */
58  NEHOGGradient &operator=(const NEHOGGradient &) = delete;
59  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
60  NEHOGGradient(NEHOGGradient &&) = delete;
61  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
63  /** Default destructor */
65  /** Initialise the function's source, destinations, phase type and border mode
66  *
67  * @param[in, out] input Input tensor. Data type supported: U8.
68  * (Written to only for @p border_mode != UNDEFINED)
69  * @param[out] output_magnitude Output tensor (magnitude). Data type supported: U16.
70  * @param[out] output_phase Output tensor.(phase). Format supported: U8
71  * @param[in] phase_type Type of @ref PhaseType
72  * @param[in] border_mode Border mode to use
73  * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
74  */
75  void configure(ITensor *input, ITensor *output_magnitude, ITensor *output_phase, PhaseType phase_type, BorderMode border_mode, uint8_t constant_border_value = 0);
76 
77  // Inherited method overridden:
78  void run() override;
79 
80 private:
81  MemoryGroup _memory_group;
82  NEDerivative _derivative;
83  std::unique_ptr<ICPPKernel> _mag_phase;
84  Tensor _gx;
85  Tensor _gy;
86 };
87 }
88 #endif /*ARM_COMPUTE_NEHOGGRADIENT_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:265
Base class for all functions.
Definition: IFunction.h:30
PhaseType
Phase calculation type.
Definition: Types.h:432
NEHOGGradient & operator=(const NEHOGGradient &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
NEHOGGradient(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default constructor.
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
void run() override
Run the kernels contained in the function.
void configure(ITensor *input, ITensor *output_magnitude, ITensor *output_phase, PhaseType phase_type, BorderMode border_mode, uint8_t constant_border_value=0)
Initialise the function&#39;s source, destinations, phase type and border mode.
~NEHOGGradient()
Default destructor.
Basic function to calculate the gradient for HOG.
Definition: NEHOGGradient.h:50
Basic implementation of the tensor interface.
Definition: Tensor.h:37
Basic function to execute first order derivative operator.
Definition: NEDerivative.h:46