Compute Library
 21.02
CLNonLinearFilterKernel Class Reference

Interface for the kernel to apply a non-linear filter. More...

#include <CLNonLinearFilterKernel.h>

Collaboration diagram for CLNonLinearFilterKernel:
[legend]

Public Member Functions

 CLNonLinearFilterKernel ()
 Default constructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, bool border_undefined)
 Set the source, destination and border mode of the kernel. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, bool border_undefined)
 Set the source, destination and border mode of the kernel. More...
 
BorderSize border_size () const override
 The size of the border for that kernel. More...
 
- Public Member Functions inherited from ICLSimple2DKernel
void run (const Window &window, cl::CommandQueue &queue) override
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
- Public Member Functions inherited from ICLSimpleKernel
 ICLSimpleKernel ()
 Constructor. More...
 
 ICLSimpleKernel (const ICLSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICLSimpleKerneloperator= (const ICLSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICLSimpleKernel (ICLSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
ICLSimpleKerneloperator= (ICLSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~ICLSimpleKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, unsigned int num_elems_processed_per_iteration, bool border_undefined=false, const BorderSize &border_size=BorderSize())
 Configure the kernel. More...
 
- Public Member Functions inherited from ICLKernel
 ICLKernel ()
 Constructor. More...
 
cl::Kernel & kernel ()
 Returns a reference to the OpenCL kernel of this object. More...
 
template<typename T >
void add_1D_array_argument (unsigned int &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed 1D array's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_2D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_2D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_3D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_4D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 4D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
virtual void run_op (ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
template<typename T >
void add_argument (unsigned int &idx, T value)
 Add the passed parameters to the object's kernel's arguments starting from the index idx. More...
 
void set_lws_hint (const cl::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
cl::NDRange lws_hint () const
 Return the Local-Workgroup-Size hint. More...
 
void set_wbsm_hint (const cl_int &wbsm_hint)
 Set the workgroup batch size modifier hint. More...
 
cl_int wbsm_hint () const
 Return the workgroup batch size modifier hint. More...
 
const std::string & config_id () const
 Get the configuration ID. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
void set_target (cl::Device &device)
 Set the targeted GPU architecture according to the CL device. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. More...
 
size_t get_max_workgroup_size ()
 Get the maximum workgroup size for the device the CLKernelLibrary uses. More...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
template<typename T , unsigned int dimension_size>
void add_array_argument (unsigned &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed array's parameters to the object's kernel's arguments starting from the index idx. More...
 
- Public Member Functions inherited from IKernel
 IKernel ()
 Constructor. More...
 
virtual ~IKernel ()=default
 Destructor. More...
 
virtual bool is_parallelisable () const
 Indicates whether or not the kernel is parallelisable. More...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ICLKernel
static constexpr unsigned int num_arguments_per_1D_array ()
 Returns the number of arguments enqueued per 1D array object. More...
 
static constexpr unsigned int num_arguments_per_1D_tensor ()
 Returns the number of arguments enqueued per 1D tensor object. More...
 
static constexpr unsigned int num_arguments_per_2D_tensor ()
 Returns the number of arguments enqueued per 2D tensor object. More...
 
static constexpr unsigned int num_arguments_per_3D_tensor ()
 Returns the number of arguments enqueued per 3D tensor object. More...
 
static constexpr unsigned int num_arguments_per_4D_tensor ()
 Returns the number of arguments enqueued per 4D tensor object. More...
 
static cl::NDRange gws_from_window (const Window &window)
 Get the global work size given an execution window. More...
 

Detailed Description

Interface for the kernel to apply a non-linear filter.

Definition at line 37 of file CLNonLinearFilterKernel.h.

Constructor & Destructor Documentation

◆ CLNonLinearFilterKernel()

Default constructor.

Definition at line 45 of file CLNonLinearFilterKernel.cpp.

46  : _border_size(0)
47 {
48 }

Member Function Documentation

◆ border_size()

BorderSize border_size ( ) const
overridevirtual

The size of the border for that kernel.

Returns
The width in number of elements of the border.

Reimplemented from IKernel.

Definition at line 50 of file CLNonLinearFilterKernel.cpp.

Referenced by CLNonLinearFilterKernel::configure().

51 {
52  return _border_size;
53 }

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output,
NonLinearFilterFunction  function,
unsigned int  mask_size,
MatrixPattern  pattern,
const uint8_t *  mask,
bool  border_undefined 
)

Set the source, destination and border mode of the kernel.

Parameters
[in]inputSource tensor. Data types supported: U8
[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_undefinedTrue if the border mode is undefined. False if it's replicate or constant.

Definition at line 55 of file CLNonLinearFilterKernel.cpp.

References CLKernelLibrary::get().

58 {
59  configure(CLKernelLibrary::get().get_compile_context(), input, output, function, mask_size, pattern, mask, border_undefined);
60 }
void configure(const ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, bool border_undefined)
Set the source, destination and border mode of the kernel.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output,
NonLinearFilterFunction  function,
unsigned int  mask_size,
MatrixPattern  pattern,
const uint8_t *  mask,
bool  border_undefined 
)

Set the source, destination and border mode of the kernel.

Parameters
[in]compile_contextThe compile context to be used.
[in]inputSource tensor. Data types supported: U8
[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_undefinedTrue if the border mode is undefined. False if it's replicate or constant.

Definition at line 62 of file CLNonLinearFilterKernel.cpp.

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, ARM_COMPUTE_ERROR_ON_MSG, ARM_COMPUTE_UNUSED, CLNonLinearFilterKernel::border_size(), arm_compute::calculate_max_window(), arm_compute::create_kernel(), ITensor::info(), arm_compute::test::validation::input, BorderSize::left, num_elems_processed_per_iteration, arm_compute::OTHER, arm_compute::test::validation::ss(), arm_compute::string_from_matrix_pattern(), arm_compute::string_from_non_linear_filter_function(), arm_compute::utility::tolower(), BorderSize::top, arm_compute::U8, arm_compute::update_window_and_padding(), and ITensorInfo::valid_region().

65 {
68  ARM_COMPUTE_ERROR_ON(mask_size != 3 && mask_size != 5);
69  ARM_COMPUTE_ERROR_ON_MSG(pattern == MatrixPattern::OTHER, "MatrixPattern::OTHER is not supported!");
70  ARM_COMPUTE_UNUSED(mask);
71 
72  _input = input;
73  _output = output;
74  _border_size = BorderSize(mask_size / 2);
75 
76  // Define build options
77  std::set<std::string> build_opts;
78  build_opts.emplace("-D" + string_from_non_linear_filter_function(function));
79 
80  // Define kernel
81  std::string pattern_name = string_from_matrix_pattern(pattern);
82  std::transform(pattern_name.begin(), pattern_name.end(), pattern_name.begin(), ::tolower);
83  std::stringstream ss;
84  ss << "non_linear_filter_" << pattern_name << mask_size << "x" << mask_size;
85 
86  // Create kernel
87  _kernel = create_kernel(compile_context, ss.str(), build_opts);
88 
89  // Configure kernel window
90  constexpr unsigned int num_elems_processed_per_iteration = 8;
91  constexpr unsigned int num_elems_read_per_iteration = 16;
92  const unsigned int num_rows_read_per_iteration = mask_size;
93 
94  Window win = calculate_max_window(*input->info(), num_elems_processed_per_iteration, border_undefined, border_size());
95 
96  AccessWindowRectangle input_access(input->info(), -border_size().left, -border_size().top, num_elems_read_per_iteration, num_rows_read_per_iteration);
98 
99  update_window_and_padding(win, input_access, output_access);
100 
101  output_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
102 
103  ICLKernel::configure_internal(win);
104 }
unsigned int top
top of the border
Definition: Types.h:375
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
const std::string & string_from_matrix_pattern(MatrixPattern pattern)
Convert a matrix pattern into a string.
Definition: Utils.cpp:187
Container for 2D border size.
Definition: Types.h:273
1 channel, 1 U8 per channel
BorderSize border_size() const override
The size of the border for that kernel.
std::stringstream ss(mlgo_str)
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
std::string tolower(std::string string)
Convert string to lower case.
Definition: Utility.h:203
Implementation of a rectangular access pattern.
cl::Kernel create_kernel(const CLCompileContext &ctx, const std::string &kernel_name, const std::set< std::string > &build_opts=std::set< std::string >())
Creates an opencl kernel using a compile context.
Definition: CLHelpers.cpp:403
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: WindowHelpers.h:46
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
Implementation of a row access pattern.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
const std::string & string_from_non_linear_filter_function(NonLinearFilterFunction function)
Translates a given non linear function to a string.
Definition: Utils.cpp:200
unsigned int left
left of the border
Definition: Types.h:378
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
unsigned int num_elems_processed_per_iteration
Any other matrix pattern.
Describe a multidimensional execution window.
Definition: Window.h:39

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