Compute Library
 19.08
CLFastCornersKernel Class Reference

CL kernel to perform fast corners. More...

#include <CLFastCornersKernel.h>

Collaboration diagram for CLFastCornersKernel:
[legend]

Public Member Functions

 CLFastCornersKernel ()
 Default constructor. More...
 
 CLFastCornersKernel (const CLFastCornersKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLFastCornersKerneloperator= (const CLFastCornersKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLFastCornersKernel (CLFastCornersKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLFastCornersKerneloperator= (CLFastCornersKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLFastCornersKernel ()=default
 Default destructor. More...
 
void configure (const ICLImage *input, ICLImage *output, float threshold, bool non_max_suppression, BorderMode border_mode)
 Initialise the kernel. More...
 
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...
 
BorderSize border_size () const override
 The size of the border for that 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...
 
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...
 
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<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...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
- 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

CL kernel to perform fast corners.

Definition at line 44 of file CLFastCornersKernel.h.

Constructor & Destructor Documentation

◆ CLFastCornersKernel() [1/3]

Default constructor.

Definition at line 40 of file CLFastCornersKernel.cpp.

41  : ICLKernel(), _input(nullptr), _output(nullptr)
42 {
43 }
ICLKernel()
Constructor.
Definition: ICLKernel.h:79

◆ CLFastCornersKernel() [2/3]

Prevent instances of this class from being copied (As this class contains pointers)

◆ CLFastCornersKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLFastCornersKernel()

~CLFastCornersKernel ( )
default

Default destructor.

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 45 of file CLFastCornersKernel.cpp.

46 {
47  return BorderSize(3);
48 }
Container for 2D border size.
Definition: Types.h:259

Referenced by CLFastCornersKernel::configure().

◆ configure()

void configure ( const ICLImage input,
ICLImage output,
float  threshold,
bool  non_max_suppression,
BorderMode  border_mode 
)

Initialise the kernel.

Parameters
[in]inputSource image. Data types supported: U8.
[out]outputOutput image. Data types supported: U8.
[in]thresholdThreshold on difference between intensity of the central pixel and pixels on Bresenham's circle of radius 3.
[in]non_max_suppressionTrue if non-maxima suppresion is applied, false otherwise.
[in]border_modeStrategy to use for borders.

Definition at line 50 of file CLFastCornersKernel.cpp.

51 {
57 
58  _input = input;
59  _output = output;
60 
61  // Create build options
62  std::set<std::string> build_opts;
63 
65  {
66  build_opts.emplace("-DUSE_MAXSUPPRESSION");
67  }
68 
69  // Create kernel
70  const std::string kernel_name = std::string("fast_corners");
71  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts));
72 
73  // Set static kernel arguments
74  unsigned int idx = 2 * num_arguments_per_2D_tensor(); // Skip the input and output parameters
75  _kernel.setArg<cl_float>(idx, static_cast<float>(threshold));
76 
77  // Configure kernel window
78  constexpr unsigned int num_elems_processed_per_iteration = 1;
79  constexpr unsigned int num_elems_read_per_iteration = 7;
80  constexpr unsigned int num_rows_read_per_iteration = 3;
81 
82  Window win = calculate_max_window(*input->info(), Steps(num_elems_processed_per_iteration), border_mode == BorderMode::UNDEFINED, BorderSize(3));
83 
84  AccessWindowHorizontal output_access(output->info(), 0, num_elems_processed_per_iteration);
85  AccessWindowRectangle input_access(input->info(), -border_size().left, -border_size().top, num_elems_read_per_iteration, num_rows_read_per_iteration);
86 
87  update_window_and_padding(win, input_access, output_access);
88 
89  output_access.set_valid_region(win, input->info()->valid_region(), border_mode == BorderMode::UNDEFINED, border_size());
90 
91  ICLKernel::configure_internal(win);
92 
93  // Set config_id for enabling LWS tuning
94  _config_id = kernel_name;
95  _config_id += "_";
96  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
97  _config_id += "_";
98  _config_id += support::cpp11::to_string(input->info()->dimension(0));
99  _config_id += "_";
100  _config_id += support::cpp11::to_string(input->info()->dimension(1));
101  _config_id += "_";
102  _config_id += support::cpp11::to_string(output->info()->dimension(0));
103  _config_id += "_";
104  _config_id += support::cpp11::to_string(output->info()->dimension(1));
105  _config_id += "_";
107  _config_id += "_";
109 }
unsigned int top
top of the border
Definition: Types.h:339
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
Container for 2D border size.
Definition: Types.h:259
1 channel, 1 U8 per channel
std::string to_string(T &&value)
Convert integer and float values to string.
virtual DataType data_type() const =0
Data type used for each element of the tensor.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:327
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window for a given tensor shape and border setting.
Definition: Helpers.cpp:28
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
const std::string & string_from_border_mode(BorderMode border_mode)
Translates a given border mode policy to a string.
Definition: Utils.cpp:228
#define ARM_COMPUTE_ERROR_ON_TENSOR_NOT_2D(t)
Definition: Validate.h:855
Implementation of a rectangular access pattern.
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:144
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: Helpers.h:402
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
static constexpr unsigned int num_arguments_per_2D_tensor()
Returns the number of arguments enqueued per 2D tensor object.
Definition: ICLKernel.h:192
std::unique_ptr< Kernel > create_kernel()
Helper function to create and return a unique_ptr pointed to a CL/GLES kernel object.
Definition: Helpers.h:86
unsigned int left
left of the border
Definition: Types.h:342
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:789
Borders are left undefined.
__kernel void non_max_suppression(__global uchar *src_ptr, uint src_stride_x, uint src_step_x, uint src_stride_y, uint src_step_y, uint src_offset_first_element_in_bytes, __global uchar *dst_ptr, uint dst_stride_x, uint dst_step_x, uint dst_stride_y, uint dst_step_y, uint dst_offset_first_element_in_bytes)
This function performs Non maxima suppression over a 3x3 window on a given image.
Definition: nonmax.cl:41
SimpleTensor< T > threshold(const SimpleTensor< T > &src, T threshold, T false_value, T true_value, ThresholdType type, T upper)
Definition: Threshold.cpp:35
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_MSG(cond,...)
Definition: Error.h:328
BorderSize border_size() const override
The size of the border for that kernel.

References ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, ARM_COMPUTE_ERROR_ON_MSG, ARM_COMPUTE_ERROR_ON_TENSOR_NOT_2D, arm_compute::test::validation::border_mode, CLFastCornersKernel::border_size(), arm_compute::calculate_max_window(), arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), CLKernelLibrary::get(), ITensor::info(), BorderSize::left, arm_compute::lower_string(), non_max_suppression(), ICLKernel::num_arguments_per_2D_tensor(), arm_compute::string_from_border_mode(), arm_compute::string_from_data_type(), arm_compute::test::validation::reference::threshold(), arm_compute::support::cpp11::to_string(), BorderSize::top, arm_compute::U8, arm_compute::UNDEFINED, arm_compute::update_window_and_padding(), and ITensorInfo::valid_region().

Referenced by CLFastCorners::configure().

◆ operator=() [1/2]

CLFastCornersKernel& operator= ( const CLFastCornersKernel )
delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ operator=() [2/2]

CLFastCornersKernel& operator= ( CLFastCornersKernel &&  )
default

Allow instances of this class to be moved.

◆ run()

void run ( const Window window,
cl::CommandQueue &  queue 
)
overridevirtual

Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.

Note
The queue is not flushed by this method, and therefore the kernel will not have been executed by the time this method returns.
Parameters
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).
[in,out]queueCommand queue on which to enqueue the kernel.

Implements ICLKernel.

Definition at line 111 of file CLFastCornersKernel.cpp.

112 {
115 
117 
118  do
119  {
120  unsigned int idx = 0;
121  add_2D_tensor_argument(idx, _input, slice);
122  add_2D_tensor_argument(idx, _output, slice);
123  enqueue(queue, *this, slice, lws_hint());
124  }
126 }
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:267
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void enqueue(cl::CommandQueue &queue, ICLKernel &kernel, const Window &window, const cl::NDRange &lws_hint=CLKernelLibrary::get().default_ndrange(), bool use_dummy_work_items=false)
Add the kernel to the command queue with the given window.
Definition: ICLKernel.cpp:39
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:247
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:307
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.
Definition: ICLKernel.h:134
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References ICLKernel::add_2D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), Window::first_slice_window_2D(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_2D(), and IKernel::window().


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