• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_CLHOGDESCRIPTOR_H
25 #define ARM_COMPUTE_CLHOGDESCRIPTOR_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/CL/CLTensor.h"
29 #include "arm_compute/runtime/CL/functions/CLHOGGradient.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 <memory>
35 
36 namespace arm_compute
37 {
38 class IHOG;
39 class CLHOGOrientationBinningKernel;
40 class CLHOGBlockNormalizationKernel;
41 /** Basic function to calculate HOG descriptor. This function calls the following OpenCL kernels:
42  *
43  * -# @ref CLHOGGradient
44  * -# @ref CLHOGOrientationBinningKernel
45  * -# @ref CLHOGBlockNormalizationKernel
46  *
47  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
48  *
49  */
50 class CLHOGDescriptor : public IFunction
51 {
52 public:
53     /** Default constructor */
54     CLHOGDescriptor(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
55     /** Prevent instances of this class from being copied */
56     CLHOGDescriptor(const CLHOGDescriptor &) = delete;
57     /** Prevent instances of this class from being copied */
58     CLHOGDescriptor &operator=(const CLHOGDescriptor &) = delete;
59     /** Default destructor */
60     ~CLHOGDescriptor();
61     /** Initialise the function's source, destination, HOG data-object and border mode
62      *
63      * @param[in, out] input                 Input tensor. Data type supported: U8
64      *                                       (Written to only for @p border_mode != UNDEFINED)
65      * @param[out]     output                Output tensor which stores the HOG descriptor. DataType supported: F32. The number of channels is equal to the number of histogram bins per block
66      * @param[in]      hog                   HOG data object which describes the HOG descriptor
67      * @param[in]      border_mode           Border mode to use.
68      * @param[in]      constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
69      */
70     void configure(ICLTensor *input, ICLTensor *output, const IHOG *hog, BorderMode border_mode, uint8_t constant_border_value = 0);
71     /** Initialise the function's source, destination, HOG data-object and border mode
72      *
73      * @param[in]      compile_context       The compile context to be used.
74      * @param[in, out] input                 Input tensor. Data type supported: U8
75      *                                       (Written to only for @p border_mode != UNDEFINED)
76      * @param[out]     output                Output tensor which stores the HOG descriptor. DataType supported: F32. The number of channels is equal to the number of histogram bins per block
77      * @param[in]      hog                   HOG data object which describes the HOG descriptor
78      * @param[in]      border_mode           Border mode to use.
79      * @param[in]      constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
80      */
81     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const IHOG *hog, BorderMode border_mode, uint8_t constant_border_value = 0);
82 
83     // Inherited method overridden:
84     void run() override;
85 
86 private:
87     MemoryGroup                                    _memory_group;
88     CLHOGGradient                                  _gradient;
89     std::unique_ptr<CLHOGOrientationBinningKernel> _orient_bin;
90     std::unique_ptr<CLHOGBlockNormalizationKernel> _block_norm;
91     CLTensor                                       _mag;
92     CLTensor                                       _phase;
93     CLTensor                                       _hog_space;
94 };
95 }
96 
97 #endif /* ARM_COMPUTE_CLHOGDESCRIPTOR_H */
98