arm_compute/runtime/NEON/functions/NEFastCorners.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_NEFASTCORNERS_H__
  25 #define __ARM_COMPUTE_NEFASTCORNERS_H__
  26
  27 #include "arm_compute/core/NEON/kernels/NEFastCornersKernel.h"
  28 #include "arm_compute/core/NEON/kernels/NEFillArrayKernel.h"
  29 #include "arm_compute/core/NEON/kernels/NEFillBorderKernel.h"
  30 #include "arm_compute/core/NEON/kernels/NENonMaximaSuppression3x3Kernel.h"
  31 #include "arm_compute/core/Types.h"
  32 #include "arm_compute/runtime/Array.h"
  33 #include "arm_compute/runtime/IFunction.h"
  34 #include "arm_compute/runtime/IMemoryManager.h"
  35 #include "arm_compute/runtime/MemoryGroup.h"
  36 #include "arm_compute/runtime/Tensor.h"
  37
  38 #include <cstdint>
  39 #include <memory>
  40
  41 namespace arm_compute
  42 {
  43 class ITensor;
  44 using IImage = ITensor;
  45
  46 /** Basic function to execute fast corners. This function call the following NEON kernels:
  47  *
  48  * -# @ref NEFastCornersKernel
  49  * -# @ref NENonMaximaSuppression3x3Kernel (executed if nonmax_suppression == true)
  50  * -# @ref NEFillArrayKernel
  51  *
  52  */
  53 class NEFastCorners : public IFunction
  54 {
  55 public:
  56     /** Constructor */
  57     NEFastCorners(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
  58     /** Initialize the function's source, destination, conv and border_mode.
  59      *
  60      * @param[in, out] input                 Source image. Data type supported: U8. (Written to only for @p border_mode != UNDEFINED)
  61      * @param[in]      threshold             Threshold on difference between intensity of the central pixel and pixels on Bresenham's circle of radius 3.
  62      * @param[in]      nonmax_suppression    If true, non-maximum suppression is applied to detected corners before being placed in the array.
  63      * @param[out]     corners               Array of keypoints to store the results.
  64      * @param[in]      border_mode           Strategy to use for borders.
  65      * @param[in]      constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
  66      */
  67     void configure(IImage *input, float threshold, bool nonmax_suppression, KeyPointArray *corners,
  68                    BorderMode border_mode, uint8_t constant_border_value = 0);
  69
  70     // Inherited methods overridden:
  71     void run() override;
  72
  73 private:
  74     MemoryGroup                     _memory_group;
  75     NEFastCornersKernel             _fast_corners_kernel;
  76     NEFillBorderKernel              _border_handler;
  77     NENonMaximaSuppression3x3Kernel _nonmax_kernel;
  78     NEFillArrayKernel               _fill_kernel;
  79     Image                           _output;
  80     Image                           _suppressed;
  81     bool                            _non_max;
  82 };
  83 }
  84 #endif /*__ARM_COMPUTE_NEFASTCORNERS_H__ */