Compute Library
 21.02
NELaplacianPyramid.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_NELAPLACIANPYRAMID_H
25 #define ARM_COMPUTE_NELAPLACIANPYRAMID_H
26 
27 #include "arm_compute/core/Types.h"
34 
35 #include <cstddef>
36 #include <cstdint>
37 #include <memory>
38 
39 namespace arm_compute
40 {
41 class ITensor;
42 
43 /** Basic function to execute laplacian pyramid. This function calls the following Neon kernels and functions:
44  *
45  * -# @ref NEGaussianPyramidHalf
46  * -# @ref NEGaussian5x5
47  * -# @ref NEArithmeticSubtraction
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 */
58 {
59 public:
60  /** Constructor */
62  /** Prevent instances of this class from being copied (As this class contains pointers) */
63  NELaplacianPyramid(const NELaplacianPyramid &) = delete;
64  /** Prevent instances of this class from being copied (As this class contains pointers) */
66  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
68  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
70  /** Default destructor */
72  /** Initialise the function's source, destinations and border mode.
73  *
74  * @param[in] input Source tensor. Data type supported: U8.
75  * @param[out] pyramid Destination pyramid tensors, Data type supported at each level: S16.
76  * @param[out] output The lowest resolution tensor necessary to reconstruct the input tensor from the pyramid. Data type supported: S16.
77  * 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:
78  * out.width = in.width() / pow(2,pyramid_levels-1) and out.height = in.height() / pow(2,pyramid_levels-1)
79  * @param[in] border_mode Border mode to use.
80  * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
81  *
82  */
83  void configure(const ITensor *input, IPyramid *pyramid, ITensor *output, BorderMode border_mode, uint8_t constant_border_value);
84 
85  // Inherited methods overridden:
86  void run() override;
87 
88 private:
89  size_t _num_levels;
90  NEGaussianPyramidHalf _gaussian_pyr_function;
91  std::vector<NEGaussian5x5> _convf;
92  std::vector<NEArithmeticSubtraction> _subf;
93  Pyramid _gauss_pyr;
94  Pyramid _conv_pyr;
95  NEDepthConvertLayer _depth_function;
96 };
97 }
98 #endif /*ARM_COMPUTE_NELAPLACIANPYRAMID_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:265
Base class for all functions.
Definition: IFunction.h:30
Interface for Neon tensor.
Definition: ITensor.h:36
NELaplacianPyramid & operator=(const NELaplacianPyramid &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Copyright (c) 2017-2021 Arm Limited.
Basic implementation of the pyramid interface.
Definition: Pyramid.h:40
void configure(const ITensor *input, IPyramid *pyramid, ITensor *output, BorderMode border_mode, uint8_t constant_border_value)
Initialise the function&#39;s source, destinations and border mode.
Basic function to execute laplacian pyramid.
Interface for pyramid data-object.
Definition: IPyramid.h:36
Basic function to execute gaussian pyramid with HALF scale factor.
~NELaplacianPyramid()
Default destructor.
Basic function to run NEDepthConvertLayerKernel.
void run() override
Run the kernels contained in the function.