arm_compute/core/CL/kernels/CLScharr3x3Kernel.h

/*
 * Copyright (c) 2016-2020 ARM Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef ARM_COMPUTE_CLSCHARR3X3KERNEL_H
#define ARM_COMPUTE_CLSCHARR3X3KERNEL_H

#include "arm_compute/core/CL/ICLKernel.h"

namespace arm_compute
{
class ICLTensor;

/** Interface for the kernel to run a 3x3 Scharr filter on a tensor.
 *
 * @f[
 *      \mathbf{G}_x=\begin{vmatrix}
 *      -3 & 0 & +3\\
 *      -10& 0 & +10\\
 *      -3 & 0 & +3
 *      \end{vmatrix}
 * @f]
 * @f[
 *      \mathbf{G}_y=\begin{vmatrix}
 *      -3 & -10 & -3\\
 *       0 & 0 & 0\\
 *      +3 & +10 & +3
 *      \end{vmatrix}
 * @f]
 */
class CLScharr3x3Kernel : public ICLKernel
{
public:
    /** Default constructor: initialize all the pointers to nullptr and parameters to zero. */
    CLScharr3x3Kernel();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLScharr3x3Kernel(const CLScharr3x3Kernel &) = delete;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLScharr3x3Kernel &operator=(const CLScharr3x3Kernel &) = delete;
    /** Allow instances of this class to be moved */
    CLScharr3x3Kernel(CLScharr3x3Kernel &&) = default;
    /** Allow instances of this class to be moved */
    CLScharr3x3Kernel &operator=(CLScharr3x3Kernel &&) = default;
    /** Initialise the kernel's source, destination and border.
     *
     * @note At least one of output_x or output_y must be set.
     *
     * @param[in]  input            Source tensor. Data types supported: U8.
     * @param[out] output_x         (Optional) Destination tensor for the X gradient, Data types supported: S16.
     * @param[out] output_y         (Optional) Destination tensor for the Y gradient, Data types supported: S16.
     * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
     */
    void configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined);
    /** Initialise the kernel's source, destination and border.
     *
     * @note At least one of output_x or output_y must be set.
     *
     * @param[in]  compile_context  The compile context to be used.
     * @param[in]  input            Source tensor. Data types supported: U8.
     * @param[out] output_x         (Optional) Destination tensor for the X gradient, Data types supported: S16.
     * @param[out] output_y         (Optional) Destination tensor for the Y gradient, Data types supported: S16.
     * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined);

    // Inherited methods overridden:
    void run(const Window &window, cl::CommandQueue &queue) override;
    BorderSize border_size() const override;

private:
    bool             _run_scharr_x; /**< Do we need to run Scharr X ? */
    bool             _run_scharr_y; /**< Do we need to run Scharr Y ? */
    const ICLTensor *_input;        /**< Input image */
    ICLTensor       *_output_x;     /**< Output image for scharr X */
    ICLTensor       *_output_y;     /**< Output image for scharr Y */
};
} // namespace arm_compute
#endif /*ARM_COMPUTE_CLSCHARR3X3KERNEL_H */