Compute Library
 21.02
NESobel3x3.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2021 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_NESOBEL3x3_H
25 #define ARM_COMPUTE_NESOBEL3x3_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 #include <cstdint>
31 
32 namespace arm_compute
33 {
34 class ITensor;
35 
36 /** Basic function to execute sobel 3x3 filter. This function calls the following Neon kernels:
37  *
38  * -# @ref NEFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
39  * -# @ref NESobel3x3Kernel
40  *
41  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
42  *
43  */
45 {
46 public:
47  /** Initialise the function's source, destinations and border mode.
48  *
49  * @note At least one of output_x or output_y must be not NULL.
50  *
51  * @param[in, out] input Source tensor. Data type supported: U8. (Written to only for @p border_mode != UNDEFINED)
52  * @param[out] output_x (optional) Destination for the Sobel 3x3 convolution along the X axis. Data type supported: S16.
53  * @param[out] output_y (optional) Destination for the Sobel 3x3 convolution along the Y axis. Data type supported: S16.
54  * @param[in] border_mode Border mode to use for the convolution.
55  * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
56  *
57  */
58  void configure(ITensor *input, ITensor *output_x, ITensor *output_y, BorderMode border_mode, uint8_t constant_border_value = 0);
59 };
60 }
61 #endif /*ARM_COMPUTE_NESOBEL3x3_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:265
void configure(ITensor *input, ITensor *output_x, ITensor *output_y, BorderMode border_mode, uint8_t constant_border_value=0)
Initialise the function&#39;s source, destinations and border mode.
Definition: NESobel3x3.cpp:34
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
Basic function to execute sobel 3x3 filter.
Definition: NESobel3x3.h:44
Basic interface for functions which have a single Neon kernel.