• 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_CLLAPLACIANRECONSTRUCT_H
25 #define ARM_COMPUTE_CLLAPLACIANRECONSTRUCT_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/CLScale.h"
32 #include "arm_compute/runtime/IFunction.h"
33 
34 #include <cstdint>
35 #include <memory>
36 
37 namespace arm_compute
38 {
39 class ICLTensor;
40 using ICLImage = ICLTensor;
41 
42 /** Basic function to execute laplacian reconstruction. This function calls the following OpenCL kernels and functions:
43  *
44  * -# @ref CLArithmeticAddition
45  * -# @ref CLScale
46  * -# @ref CLDepthConvertLayer
47  *
48  * This function reconstructs the original image from a Laplacian Image Pyramid.
49  *
50  *  The input image is added to the last level of the Laplacian pyramid L(n-2), the resulting image is upsampled to the
51  *  resolution of the next pyramid level.
52  *
53  *  I(n-2) = upsample( input + L(n-1)
54  *
55  *  For each pyramid level i, except i=0 and i=n-1:
56  *  I(i-1) = upsample(I(i) + L(i))
57  *
58  *  output = I(0) + L(0)
59  *
60  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
61  *
62 */
63 class CLLaplacianReconstruct : public IFunction
64 {
65 public:
66     /** Constructor */
67     CLLaplacianReconstruct();
68     /** Initialise the function's source, destinations and border mode.
69      *
70      * The Output image must have the same size as the first level of the pyramid.
71      * The Input image must have the same size as the last level of the pyramid.
72      *
73      * The idea is to reconstuct the original hi-res image from a low-res representation of it and the laplacian pyramid.
74      *
75      * @param[in]  pyramid               Laplacian pyramid tensors, Data types supported at each level: S16.
76      * @param[in]  input                 Source tensor. Data types supported: S16.
77      * @param[out] output                Output tensor. Data types supported: U8.
78      * @param[in]  border_mode           Border mode to use for the convolution.
79      * @param[in]  constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
80      *
81      */
82     void configure(const CLPyramid *pyramid, ICLTensor *input, ICLTensor *output, BorderMode border_mode, uint8_t constant_border_value);
83     /** Initialise the function's source, destinations and border mode.
84      *
85      * The Output image must have the same size as the first level of the pyramid.
86      * The Input image must have the same size as the last level of the pyramid.
87      *
88      * The idea is to reconstuct the original hi-res image from a low-res representation of it and the laplacian pyramid.
89      *
90      * @param[in]  compile_context       The compile context to be used.
91      * @param[in]  pyramid               Laplacian pyramid tensors, Data types supported at each level: S16.
92      * @param[in]  input                 Source tensor. Data types supported: S16.
93      * @param[out] output                Output tensor. Data types supported: U8.
94      * @param[in]  border_mode           Border mode to use for the convolution.
95      * @param[in]  constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
96      *
97      */
98     void configure(const CLCompileContext &compile_context, const CLPyramid *pyramid, ICLTensor *input, ICLTensor *output, BorderMode border_mode, uint8_t constant_border_value);
99 
100     // Inherited methods overridden:
101     void run() override;
102 
103 private:
104     CLPyramid                         _tmp_pyr;
105     std::vector<CLArithmeticAddition> _addf;
106     std::vector<CLScale>              _scalef;
107     CLDepthConvertLayer               _depthf;
108 };
109 }
110 #endif /*ARM_COMPUTE_CLLAPLACIANRECONSTRUCT_H */
111