arm_compute/runtime/NEON/functions/NELaplacianPyramid.h

   1 /*
   2  * Copyright (c) 2016, 2017 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"
  28 #include "arm_compute/runtime/IFunction.h"
  29 #include "arm_compute/runtime/NEON/functions/NEArithmeticSubtraction.h"
  30 #include "arm_compute/runtime/NEON/functions/NEDepthConvertLayer.h"
  31 #include "arm_compute/runtime/NEON/functions/NEGaussian5x5.h"
  32 #include "arm_compute/runtime/NEON/functions/NEGaussianPyramid.h"
  33 #include "arm_compute/runtime/Pyramid.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 class NELaplacianPyramid : public IFunction
  55 {
  56 public:
  57     /** Constructor */
  58     NELaplacianPyramid();
  59     /** Initialise the function's source, destinations and border mode.
  60      *
  61      * @param[in]  input                 Source tensor. Data type supported: U8.
  62      * @param[out] pyramid               Destination pyramid tensors, Data type supported at each level: S16.
  63      * @param[out] output                The lowest resolution tensor necessary to reconstruct the input tensor from the pyramid. Data type supported: S16.
  64      *                                   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:
  65      *                                   out.width = in.width() / pow(2,pyramid_levels-1) and out.height = in.height() / pow(2,pyramid_levels-1)
  66      * @param[in]  border_mode           Border mode to use.
  67      * @param[in]  constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
  68      *
  69      */
  70     void configure(const ITensor *input, IPyramid *pyramid, ITensor *output, BorderMode border_mode, uint8_t constant_border_value);
  71
  72     // Inherited methods overridden:
  73     void run() override;
  74
  75 private:
  76     size_t                                     _num_levels;
  77     NEGaussianPyramidHalf                      _gaussian_pyr_function;
  78     std::unique_ptr<NEGaussian5x5[]>           _convf;
  79     std::unique_ptr<NEArithmeticSubtraction[]> _subf;
  80     Pyramid                                    _gauss_pyr;
  81     Pyramid                                    _conv_pyr;
  82     NEDepthConvertLayer                        _depth_function;
  83 };
  84 }
  85 #endif /*__ARM_COMPUTE_NELAPLACIANPYRAMID_H__ */