Compute Library
 21.02
CLNonLinearFilter Class Reference

Basic function to execute non linear filter. More...

#include <CLNonLinearFilter.h>

Collaboration diagram for CLNonLinearFilter:
[legend]

Public Member Functions

void configure (ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, BorderMode border_mode, uint8_t constant_border_value=0)
 Initialize the function's source, destination, conv and border_mode. More...
 
void configure (const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, BorderMode border_mode, uint8_t constant_border_value=0)
 Initialize the function's source, destination, conv and border_mode. More...
 
- Public Member Functions inherited from ICLSimpleFunction
 ICLSimpleFunction (CLRuntimeContext *ctx=nullptr)
 Constructor. More...
 
 ICLSimpleFunction (const ICLSimpleFunction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICLSimpleFunction (ICLSimpleFunction &&)=default
 Default move constructor. More...
 
ICLSimpleFunctionoperator= (const ICLSimpleFunction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICLSimpleFunctionoperator= (ICLSimpleFunction &&)=default
 Default move assignment operator. More...
 
 ~ICLSimpleFunction ()
 Default destructor. More...
 
void run () override final
 Run the kernels contained in the function. More...
 
- Public Member Functions inherited from IFunction
virtual ~IFunction ()=default
 Destructor. More...
 
virtual void prepare ()
 Prepare the function for executing. More...
 

Detailed Description

Basic function to execute non linear filter.

This function calls the following OpenCL kernels:

  1. CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
  2. CLNonLinearFilterKernel
Note
Supported mask dimensions squares of sizes 3, 5
Deprecated:
This function is deprecated and is intended to be removed in 21.05 release

Definition at line 47 of file CLNonLinearFilter.h.

Member Function Documentation

◆ configure() [1/2]

void configure ( ICLTensor input,
ICLTensor output,
NonLinearFilterFunction  function,
unsigned int  mask_size,
MatrixPattern  pattern,
const uint8_t *  mask,
BorderMode  border_mode,
uint8_t  constant_border_value = 0 
)

Initialize the function's source, destination, conv and border_mode.

Parameters
[in,out]inputSource tensor. Data types supported: U8. (Written to only for border_mode != UNDEFINED)
[out]outputDestination tensor. Data types supported: U8
[in]functionNon linear function to perform
[in]mask_sizeMask size. Supported sizes: 3, 5
[in]patternMask pattern
[in]maskThe given mask. Will be used only if pattern is specified to PATTERN_OTHER
[in]border_modeStrategy to use for borders.
[in]constant_border_value(Optional) Constant value to use for borders if border_mode is set to CONSTANT.

Definition at line 33 of file CLNonLinearFilter.cpp.

References CLKernelLibrary::get().

35 {
36  configure(CLKernelLibrary::get().get_compile_context(), input, output, function, mask_size, pattern, mask, border_mode, constant_border_value);
37 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, BorderMode border_mode, uint8_t constant_border_value=0)
Initialize the function&#39;s source, destination, conv and border_mode.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
ICLTensor input,
ICLTensor output,
NonLinearFilterFunction  function,
unsigned int  mask_size,
MatrixPattern  pattern,
const uint8_t *  mask,
BorderMode  border_mode,
uint8_t  constant_border_value = 0 
)

Initialize the function's source, destination, conv and border_mode.

Parameters
[in]compile_contextThe compile context to be used.
[in,out]inputSource tensor. Data types supported: U8. (Written to only for border_mode != UNDEFINED)
[out]outputDestination tensor. Data types supported: U8
[in]functionNon linear function to perform
[in]mask_sizeMask size. Supported sizes: 3, 5
[in]patternMask pattern
[in]maskThe given mask. Will be used only if pattern is specified to PATTERN_OTHER
[in]border_modeStrategy to use for borders.
[in]constant_border_value(Optional) Constant value to use for borders if border_mode is set to CONSTANT.

Definition at line 39 of file CLNonLinearFilter.cpp.

References arm_compute::UNDEFINED.

41 {
42  auto k = std::make_unique<CLNonLinearFilterKernel>();
43  k->configure(compile_context, input, output, function, mask_size, pattern, mask, border_mode == BorderMode::UNDEFINED);
44  _kernel = std::move(k);
45  _border_handler->configure(compile_context, input, _kernel->border_size(), border_mode, PixelValue(constant_border_value));
46 }
Class describing the value of a pixel for any image format.
Definition: PixelValue.h:34
Borders are left undefined.

The documentation for this class was generated from the following files: