blob: 0859a09bdb24c6e1cb8754b5ed7d2fd08a3f8197 [file] [log] [blame]
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001/*
Michalis Spyrouf4643372019-11-29 16:17:13 +00002 * Copyright (c) 2016-2019 ARM Limited.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01003 *
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 */
Michalis Spyrouf4643372019-11-29 16:17:13 +000024#ifndef ARM_COMPUTE_CLNONMAXIMASUPPRESSION3X3_H
25#define ARM_COMPUTE_CLNONMAXIMASUPPRESSION3X3_H
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026
27#include "arm_compute/core/Types.h"
28#include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29
30namespace arm_compute
31{
32class ICLTensor;
33
34/** Basic function to execute non-maxima suppression over a 3x3 window. This function calls the following CL kernels:
35 *
36 * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
37 * -# @ref CLNonMaximaSuppression3x3Kernel
38 */
39class CLNonMaximaSuppression3x3 : public ICLSimpleFunction
40{
41public:
42 /** Initialise the function's source, destinations and border mode.
43 *
44 * @note The implementation supports just 2 border modes: UNDEFINED and CONSTANT
45 * The constant values used with CONSTANT border mode is 0
46 *
47 * @param[in,out] input Source tensor. Data types supported: U8, F32. (Written to only for @p border_mode != UNDEFINED)
48 * @param[out] output Destination for the Non-Maxima suppressions 3x3. Data types supported: same as @p input.
49 * @param[in] border_mode Border mode to use for non-maxima suppression.
50 * The implementation supports just 2 border modes: UNDEFINED and CONSTANT
51 */
52 void configure(ICLTensor *input, ICLTensor *output, BorderMode border_mode);
53};
54}
Michalis Spyrouf4643372019-11-29 16:17:13 +000055#endif /* ARM_COMPUTE_CLNONMAXIMASUPPRESSION3X3_H */