Compute Library
 19.08
CLEdgeTraceKernel Class Reference

OpenCL kernel to perform Edge tracing. More...

#include <CLCannyEdgeKernel.h>

Collaboration diagram for CLEdgeTraceKernel:
[legend]

Public Member Functions

 CLEdgeTraceKernel ()
 Constructor. More...
 
 CLEdgeTraceKernel (const CLEdgeTraceKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLEdgeTraceKerneloperator= (const CLEdgeTraceKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
void configure (const ICLTensor *input, ICLTensor *output, int32_t upper_thr, int32_t lower_thr, ICLTensor *visited, ICLTensor *recorded, ICLTensor *l1_stack, ICLTensor *l1_stack_counter)
 Initialise the kernel's source, destination and border mode. 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...
 
- 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...
 
virtual BorderSize border_size () const
 The size of the border for that kernel. 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

OpenCL kernel to perform Edge tracing.

Definition at line 106 of file CLCannyEdgeKernel.h.

Constructor & Destructor Documentation

◆ CLEdgeTraceKernel() [1/2]

Constructor.

Definition at line 189 of file CLCannyEdgeKernel.cpp.

190  : _input(nullptr), _output(nullptr), _lower_thr(0), _upper_thr(0), _visited(nullptr), _recorded(nullptr), _l1_stack(nullptr), _l1_stack_counter(nullptr)
191 {
192 }

◆ CLEdgeTraceKernel() [2/2]

CLEdgeTraceKernel ( const CLEdgeTraceKernel )
delete

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

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output,
int32_t  upper_thr,
int32_t  lower_thr,
ICLTensor visited,
ICLTensor recorded,
ICLTensor l1_stack,
ICLTensor l1_stack_counter 
)

Initialise the kernel's source, destination and border mode.

Parameters
[in]inputSource tensor. Data types supported: U8.
[out]outputDestination tensor. Data types supported: U8.
[in]upper_thrUpper threshold used for the hysteresis
[in]lower_thrLower threshold used for the hysteresis
[in,out]visitedTensor for keeping the visited pixels. Data types supported: U32. Expected to be initialized to 0 before each run.
[in,out]recordedTensor for keeping the recorded pixels. Data types supported: U32 Expected to be initialized to 0 before each run.
[in,out]l1_stackTensor with the L1 stack for each pixel. Data types supported: S32. Expected to be initialized to 0 before each run.
[in,out]l1_stack_counterTensor for counting the elements in the L1 stack of each pixel. Data types supported: U8. Expected to be initialized to 0 before each run.

Definition at line 194 of file CLCannyEdgeKernel.cpp.

196 {
203 
204  _input = input;
205  _output = output;
206  _lower_thr = lower_thr;
207  _upper_thr = upper_thr;
208  _visited = visited;
209  _recorded = recorded;
210  _l1_stack = l1_stack;
211  _l1_stack_counter = l1_stack_counter;
212 
213  // Create build opts
214  std::set<std::string> built_opts;
215  built_opts.emplace("-DDATA_TYPE_IN=" + get_cl_type_from_data_type(input->info()->data_type()));
216  built_opts.emplace("-DDATA_TYPE_OUT=" + get_cl_type_from_data_type(output->info()->data_type()));
217 
218  // Create kernel
219  const std::string kernel_name = std::string("hysteresis");
220  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, built_opts));
221 
222  // Set constant kernel args
223  unsigned int width = _input->info()->dimension(0);
224  unsigned int height = _input->info()->dimension(1);
225  unsigned int idx = 6 * num_arguments_per_2D_tensor(); //Skip the input and output parameters
226  _kernel.setArg(idx++, static_cast<cl_uint>(_lower_thr));
227  _kernel.setArg(idx++, static_cast<cl_uint>(_upper_thr));
228  _kernel.setArg(idx++, static_cast<cl_uint>(width));
229  _kernel.setArg(idx++, static_cast<cl_uint>(height));
230 
231  // Configure kernel window
232  constexpr unsigned int num_elems_processed_per_iteration = 1;
233  Window win = calculate_max_window(*_input->info(), Steps(num_elems_processed_per_iteration));
234 
235  AccessWindowHorizontal output_access(_output->info(), 0, num_elems_processed_per_iteration);
236  AccessWindowHorizontal visited_access(_visited->info(), 0, num_elems_processed_per_iteration);
237  AccessWindowHorizontal recorded_access(_recorded->info(), 0, num_elems_processed_per_iteration);
238  AccessWindowHorizontal l1_stack_access(_l1_stack->info(), 0, num_elems_processed_per_iteration);
239  AccessWindowHorizontal l1_stack_counter_access(_l1_stack_counter->info(), 0, num_elems_processed_per_iteration);
240 
242  AccessWindowHorizontal(_input->info(), 0, num_elems_processed_per_iteration),
243  output_access,
244  visited_access,
245  recorded_access,
246  l1_stack_access,
247  l1_stack_counter_access);
248 
249  output_access.set_valid_region(win, _input->info()->valid_region());
250  visited_access.set_valid_region(win, _input->info()->valid_region());
251  recorded_access.set_valid_region(win, _input->info()->valid_region());
252  l1_stack_access.set_valid_region(win, _input->info()->valid_region());
253  l1_stack_counter_access.set_valid_region(win, _input->info()->valid_region());
254 
255  ICLKernel::configure_internal(win);
256 
257  // Set config_id for enabling LWS tuning
258  _config_id = kernel_name;
259  _config_id += "_";
260  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
261  _config_id += "_";
262  _config_id += support::cpp11::to_string(input->info()->dimension(0));
263  _config_id += "_";
264  _config_id += support::cpp11::to_string(input->info()->dimension(1));
265  _config_id += "_";
266  _config_id += lower_string(string_from_format(output->info()->format()));
267  _config_id += "_";
268  _config_id += support::cpp11::to_string(output->info()->dimension(0));
269  _config_id += "_";
270  _config_id += support::cpp11::to_string(output->info()->dimension(1));
271 }
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
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.
1 channel, 1 U16 per channel
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.
1 channel, 1 S32 per channel
virtual Format format() const =0
Colour format of the image.
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
1 channel, 1 U32 per channel
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:35
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
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:789
Describe a multidimensional execution window.
Definition: Window.h:39
const std::string & string_from_format(Format format)
Convert a tensor format into a string.
Definition: Utils.cpp:85

References ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, arm_compute::calculate_max_window(), arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::format(), CLKernelLibrary::get(), arm_compute::get_cl_type_from_data_type(), ITensor::info(), arm_compute::lower_string(), ICLKernel::num_arguments_per_2D_tensor(), arm_compute::S32, arm_compute::string_from_data_type(), arm_compute::string_from_format(), arm_compute::support::cpp11::to_string(), arm_compute::U16, arm_compute::U32, arm_compute::U8, arm_compute::update_window_and_padding(), and ITensorInfo::valid_region().

Referenced by CLCannyEdge::configure().

◆ operator=()

CLEdgeTraceKernel& operator= ( const CLEdgeTraceKernel )
delete

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

◆ 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 273 of file CLCannyEdgeKernel.cpp.

274 {
277 
279  do
280  {
281  unsigned int idx = 0;
282  add_2D_tensor_argument(idx, _input, slice);
283  add_2D_tensor_argument(idx, _output, slice);
284  add_2D_tensor_argument(idx, _visited, slice);
285  add_2D_tensor_argument(idx, _recorded, slice);
286  add_2D_tensor_argument(idx, _l1_stack, slice);
287  add_2D_tensor_argument(idx, _l1_stack_counter, slice);
288 
289  enqueue(queue, *this, slice, lws_hint());
290  }
292 }
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: