arm_compute/core/NEON/kernels/NEScharr3x3Kernel.h

   1 /*
   2  * Copyright (c) 2016-2018 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_NESCHARR3x3KERNEL_H__
  25 #define __ARM_COMPUTE_NESCHARR3x3KERNEL_H__
  26
  27 #include "arm_compute/core/NEON/INEKernel.h"
  28
  29 namespace arm_compute
  30 {
  31 class ITensor;
  32
  33 /** Interface for the kernel to run a 3x3 Scharr filter on a tensor.
  34  *
  35 * @f[
  36 *      \mathbf{G}_x=\begin{vmatrix}
  37 *      -3 & 0 & +3\\
  38 *      -10& 0 & +10\\
  39 *      -3 & 0 & +3
  40 *      \end{vmatrix}
  41 * @f]
  42 */
  43 class NEScharr3x3Kernel : public INEKernel
  44 {
  45 public:
  46     const char *name() const override
  47     {
  48         return "NEScharr3x3Kernel";
  49     }
  50     /** Default constructor */
  51     NEScharr3x3Kernel();
  52     /** Prevent instances of this class from being copied (As this class contains pointers) */
  53     NEScharr3x3Kernel(const NEScharr3x3Kernel &) = delete;
  54     /** Prevent instances of this class from being copied (As this class contains pointers) */
  55     NEScharr3x3Kernel &operator=(const NEScharr3x3Kernel &) = delete;
  56     /** Allow instances of this class to be moved */
  57     NEScharr3x3Kernel(NEScharr3x3Kernel &&) = default;
  58     /** Allow instances of this class to be moved */
  59     NEScharr3x3Kernel &operator=(NEScharr3x3Kernel &&) = default;
  60     /** Default destructor */
  61     ~NEScharr3x3Kernel() = default;
  62
  63     /** Initialise the kernel's source, destination and border.
  64      *
  65      * @note At least one of output_x or output_y must be set.
  66      *
  67      * @param[in]  input            Source tensor. Data type supported: U8.
  68      * @param[out] output_x         (Optional) Destination tensor for the X gradient. Data type supported: S16.
  69      * @param[out] output_y         (Optional) Destination tensor for the Y gradient. Data type supported: S16.
  70      * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
  71      */
  72     void configure(const ITensor *input, ITensor *output_x, ITensor *output_y, bool border_undefined);
  73
  74     // Inherited methods overridden:
  75     void run(const Window &window, const ThreadInfo &info) override;
  76     BorderSize border_size() const override;
  77
  78 private:
  79     bool           _run_scharr_x; /**< Do we need to run Scharr X ? */
  80     bool           _run_scharr_y; /**< Do we need to run Scharr Y ? */
  81     const ITensor *_input;        /**< Input tensor */
  82     ITensor       *_output_x;     /**< Output tensor for scharr X */
  83     ITensor       *_output_y;     /**< Output tensor for scharr Y */
  84 };
  85 } // namespace arm_compute
  86 #endif /*__ARM_COMPUTE_NESCHARR3x3KERNEL_H__ */