Compute Library
 21.02
NELaplacianReconstruct.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_NELAPLACIANRECONSTRUCT_H
25 #define ARM_COMPUTE_NELAPLACIANRECONSTRUCT_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 using IImage = ITensor;
41 
42 /** Basic function to execute laplacian reconstruction. This function calls the following Neon kernels and functions:
43  *
44  * -# @ref NEArithmeticAddition
45  * -# @ref NEScale
46  * -# @ref NEDepthConvertLayer
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 */
64 {
65 public:
66  /** Constructor */
68  /** Prevent instances of this class from being copied (As this class contains pointers) */
70  /** Prevent instances of this class from being copied (As this class contains pointers) */
72  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
74  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
76  /** Default destructor */
78  /** Initialise the function's source, destinations and border mode.
79  *
80  * The Output image must have the same size as the first level of the pyramid.
81  * The Input image must have the same size as the last level of the pyramid.
82  *
83  * The idea is to reconstuct the original hi-res image from a low-res representation of it and the laplacian pyramid.
84  *
85  * @param[in] pyramid Laplacian pyramid tensors, Data type supported at each level: S16.
86  * @param[in] input Source tensor. Data type supported: S16.
87  * @param[out] output Output tensor. Data type supported: U8.
88  * @param[in] border_mode Border mode to use for the convolution.
89  * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
90  *
91  */
92  void configure(const IPyramid *pyramid, ITensor *input, ITensor *output, BorderMode border_mode, uint8_t constant_border_value);
93 
94  // Inherited methods overridden:
95  void run() override;
96 
97 private:
98  Pyramid _tmp_pyr;
99  std::vector<NEArithmeticAddition> _addf;
100  std::vector<NEScale> _scalef;
101  NEDepthConvertLayer _depthf;
102 };
103 }
104 #endif /*ARM_COMPUTE_NELAPLACIANRECONSTRUCT_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:265
Base class for all functions.
Definition: IFunction.h:30
NELaplacianReconstruct & operator=(const NELaplacianReconstruct &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Basic function to execute laplacian reconstruction.
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
Basic implementation of the pyramid interface.
Definition: Pyramid.h:40
Interface for pyramid data-object.
Definition: IPyramid.h:36
void configure(const IPyramid *pyramid, ITensor *input, ITensor *output, BorderMode border_mode, uint8_t constant_border_value)
Initialise the function&#39;s source, destinations and border mode.
ITensor IImage
Interface for CPP Images.
Basic function to run NEDepthConvertLayerKernel.
~NELaplacianReconstruct()
Default destructor.
void run() override
Run the kernels contained in the function.