arm_compute/runtime/NEON/functions/NEScale.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_NESCALEIMAGE_H__
  25 #define __ARM_COMPUTE_NESCALEIMAGE_H__
  26
  27 #include "arm_compute/core/NEON/kernels/NEFillBorderKernel.h"
  28 #include "arm_compute/core/NEON/kernels/NEScaleKernel.h"
  29 #include "arm_compute/core/Types.h"
  30 #include "arm_compute/runtime/IFunction.h"
  31 #include "arm_compute/runtime/Tensor.h"
  32
  33 #include <cstdint>
  34
  35 namespace arm_compute
  36 {
  37 class ITensor;
  38
  39 /** Basic function to run @ref NEScaleKernel */
  40 class NEScale : public IFunction
  41 {
  42 public:
  43     /** Constructor
  44      *
  45      * Initialize NEScale
  46      */
  47     NEScale();
  48     /** Initialize the function's source, destination, interpolation type and border_mode.
  49      *
  50      * @param[in, out] input                 Source tensor. Data type supported: U8/F32. (Written to only for @p border_mode != UNDEFINED)
  51      * @param[out]     output                Destination tensor. Data type supported: Same as @p input. All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
  52      * @param[in]      policy                The interpolation type.
  53      * @param[in]      border_mode           Strategy to use for borders.
  54      * @param[in]      constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
  55      * @param[in]      sampling_policy       (Optional) Sampling policy used by the interpolation. Defaults to @ref SamplingPolicy::CENTER
  56      */
  57     void configure(ITensor *input, ITensor *output, InterpolationPolicy policy, BorderMode border_mode, PixelValue constant_border_value = PixelValue(),
  58                    SamplingPolicy sampling_policy = SamplingPolicy::CENTER);
  59
  60     // Inherited methods overridden:
  61     void run() override;
  62
  63 private:
  64     Tensor             _offsets;        /**< Offset to access the element with NEAREST interpolation or the top-left element with BILINEAR interpolation in the input tensor */
  65     Tensor             _dx;             /**< Element's distance between the X real coordinate and the smallest X following integer */
  66     Tensor             _dy;             /**< Element's distance between the Y real coordinate and the smallest Y following integer */
  67     NEScaleKernel      _scale_kernel;   /**< Kernel to perform the scaling */
  68     NEFillBorderKernel _border_handler; /**< kernel to handle tensor borders */
  69 };
  70 }
  71 #endif /*__ARM_COMPUTE_NESCALEIMAGE_H__ */