• 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_CLLAPLACIANPYRAMID_H
25 #define ARM_COMPUTE_CLLAPLACIANPYRAMID_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/CL/CLPyramid.h"
29 #include "arm_compute/runtime/CL/functions/CLDepthConvertLayer.h"
30 #include "arm_compute/runtime/CL/functions/CLElementwiseOperations.h"
31 #include "arm_compute/runtime/CL/functions/CLGaussian5x5.h"
32 #include "arm_compute/runtime/CL/functions/CLGaussianPyramid.h"
33 #include "arm_compute/runtime/IFunction.h"
34 
35 #include <cstddef>
36 #include <cstdint>
37 #include <memory>
38 
39 namespace arm_compute
40 {
41 class ICLTensor;
42 
43 /** Basic function to execute laplacian pyramid. This function calls the following OpenCL kernels and functions:
44  *
45  * -# @ref CLGaussianPyramidHalf
46  * -# @ref CLGaussian5x5
47  * -# @ref CLArithmeticSubtraction
48  *
49  *  First a Gaussian pyramid is created. Then, for each level i, the corresponding tensor I(i) is blurred with the Gaussian 5x5 filter, and then
50  *  difference between the two tensors is the corresponding level L(i) of the Laplacian pyramid.
51  *  L(i) = I(i) - Gaussian5x5(I(i))
52  *  Level 0 has always the same first two dimensions as the input tensor.
53  *
54  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
55  *
56 */
57 class CLLaplacianPyramid : public IFunction
58 {
59 public:
60     /** Constructor */
61     CLLaplacianPyramid();
62     /** Initialise the function's source, destinations and border mode.
63      *
64      * @param[in]  input                 Source tensor. Data types supported: U8.
65      * @param[out] pyramid               Destination pyramid tensors, Data types supported at each level: S16.
66      * @param[out] output                The lowest resolution tensor necessary to reconstruct the input tensor from the pyramid. Data types supported: S16.
67      *                                   The first two dimensions of this tensor must match the first two dimensions of the tensor in the last level of the pyramid, that is:
68      *                                   output.width = input.width() / pow(2,pyramid_levels-1) and out.height = in.height() / pow(2,pyramid_levels-1)
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     void configure(ICLTensor *input, CLPyramid *pyramid, ICLTensor *output, BorderMode border_mode, uint8_t constant_border_value);
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]  input                 Source tensor. Data types supported: U8.
78      * @param[out] pyramid               Destination pyramid tensors, Data types supported at each level: S16.
79      * @param[out] output                The lowest resolution tensor necessary to reconstruct the input tensor from the pyramid. Data types supported: S16.
80      *                                   The first two dimensions of this tensor must match the first two dimensions of the tensor in the last level of the pyramid, that is:
81      *                                   output.width = input.width() / pow(2,pyramid_levels-1) and out.height = in.height() / pow(2,pyramid_levels-1)
82      * @param[in]  border_mode           Border mode to use.
83      * @param[in]  constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
84      *
85      */
86     void configure(const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, ICLTensor *output, BorderMode border_mode, uint8_t constant_border_value);
87 
88     // Inherited methods overridden:
89     void run() override;
90 
91 private:
92     size_t                               _num_levels;
93     CLGaussianPyramidHalf                _gaussian_pyr_function;
94     std::vector<CLGaussian5x5>           _convf;
95     std::vector<CLArithmeticSubtraction> _subf;
96     CLDepthConvertLayer                  _depth_function;
97     CLPyramid                            _gauss_pyr;
98     CLPyramid                            _conv_pyr;
99 };
100 }
101 #endif /*ARM_COMPUTE_CLLAPLACIANPYRAMID_H */
102