Compute Library
 21.02
NENonMaximaSuppression3x3.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_NENONMAXIMASUPPRESSION3X3_H
25 #define ARM_COMPUTE_NENONMAXIMASUPPRESSION3X3_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 
34 /** Basic function to execute non-maxima suppression over a 3x3 window. This function calls the following Neon kernels:
35  *
36  * -# @ref NEFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
37  * -# @ref NENonMaximaSuppression3x3Kernel
38  *
39  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
40  *
41  */
43 {
44 public:
45  /** Initialise the function's source, destinations and border mode.
46  *
47  * @note The implementation supports just 2 border modes: UNDEFINED and CONSTANT
48  * The constant values used with CONSTANT border mode is 0
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 for the Non-Maxima suppressions 3x3. Data type supported: same as @p input
52  * @param[in] border_mode Border mode to use for non-maxima suppression. The implementation supports just 2 border modes: UNDEFINED and CONSTANT
53  *
54  */
55  void configure(ITensor *input, ITensor *output, BorderMode border_mode);
56 };
57 }
58 #endif /* ARM_COMPUTE_NENONMAXIMASUPPRESSION3X3_H */
BorderMode
Methods available to handle borders.
Definition: Types.h:265
Basic function to execute non-maxima suppression over a 3x3 window.
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
void configure(ITensor *input, ITensor *output, BorderMode border_mode)
Initialise the function's source, destinations and border mode.
Basic interface for functions which have a single Neon kernel.