1 /* 2 * Copyright (c) 2017-2020 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_CLNONLINEARFILTER_H 25 #define ARM_COMPUTE_CLNONLINEARFILTER_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h" 29 30 #include <cstdint> 31 32 namespace arm_compute 33 { 34 class CLCompileContext; 35 class ICLTensor; 36 37 /** Basic function to execute non linear filter. This function calls the following OpenCL kernels: 38 * 39 * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE) 40 * -# @ref CLNonLinearFilterKernel 41 * 42 * @note Supported mask dimensions squares of sizes 3, 5 43 * 44 * @deprecated This function is deprecated and is intended to be removed in 21.05 release 45 * 46 */ 47 class CLNonLinearFilter : public ICLSimpleFunction 48 { 49 public: 50 /** Initialize the function's source, destination, conv and border_mode. 51 * 52 * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) 53 * @param[out] output Destination tensor. Data types supported: U8 54 * @param[in] function Non linear function to perform 55 * @param[in] mask_size Mask size. Supported sizes: 3, 5 56 * @param[in] pattern Mask pattern 57 * @param[in] mask The given mask. Will be used only if pattern is specified to PATTERN_OTHER 58 * @param[in] border_mode Strategy to use for borders. 59 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 60 */ 61 void configure(ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, 62 BorderMode border_mode, uint8_t constant_border_value = 0); 63 /** Initialize the function's source, destination, conv and border_mode. 64 * 65 * @param[in] compile_context The compile context to be used. 66 * @param[in,out] input Source tensor. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED) 67 * @param[out] output Destination tensor. Data types supported: U8 68 * @param[in] function Non linear function to perform 69 * @param[in] mask_size Mask size. Supported sizes: 3, 5 70 * @param[in] pattern Mask pattern 71 * @param[in] mask The given mask. Will be used only if pattern is specified to PATTERN_OTHER 72 * @param[in] border_mode Strategy to use for borders. 73 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 74 */ 75 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, 76 BorderMode border_mode, uint8_t constant_border_value = 0); 77 }; 78 } 79 #endif /*ARM_COMPUTE_CLNONLINEARFILTER_H */ 80