Compute Library
 21.02
CLScharr3x3Kernel Class Reference

Interface for the kernel to run a 3x3 Scharr filter on a tensor. More...

#include <CLScharr3x3Kernel.h>

Collaboration diagram for CLScharr3x3Kernel:
[legend]

Public Member Functions

 CLScharr3x3Kernel ()
 Default constructor: initialize all the pointers to nullptr and parameters to zero. More...
 
 CLScharr3x3Kernel (const CLScharr3x3Kernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLScharr3x3Kerneloperator= (const CLScharr3x3Kernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLScharr3x3Kernel (CLScharr3x3Kernel &&)=default
 Allow instances of this class to be moved. More...
 
CLScharr3x3Kerneloperator= (CLScharr3x3Kernel &&)=default
 Allow instances of this class to be moved. More...
 
void configure (const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
 Initialise the kernel's source, destination and border. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
 Initialise the kernel's source, destination and border. 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...
 
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 run a 3x3 Scharr filter on a tensor.

\[ \mathbf{G}_x=\begin{vmatrix} -3 & 0 & +3\\ -10& 0 & +10\\ -3 & 0 & +3 \end{vmatrix} \]

\[ \mathbf{G}_y=\begin{vmatrix} -3 & -10 & -3\\ 0 & 0 & 0\\ +3 & +10 & +3 \end{vmatrix} \]

Definition at line 50 of file CLScharr3x3Kernel.h.

Constructor & Destructor Documentation

◆ CLScharr3x3Kernel() [1/3]

Default constructor: initialize all the pointers to nullptr and parameters to zero.

Definition at line 38 of file CLScharr3x3Kernel.cpp.

39  : _run_scharr_x(false), _run_scharr_y(false), _input(nullptr), _output_x(nullptr), _output_y(nullptr)
40 {
41 }

◆ CLScharr3x3Kernel() [2/3]

CLScharr3x3Kernel ( const CLScharr3x3Kernel )
delete

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

◆ CLScharr3x3Kernel() [3/3]

Allow instances of this class to be moved.

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 43 of file CLScharr3x3Kernel.cpp.

Referenced by CLScharr3x3Kernel::configure().

44 {
45  return BorderSize(1);
46 }
Container for 2D border size.
Definition: Types.h:273

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output_x,
ICLTensor output_y,
bool  border_undefined 
)

Initialise the kernel's source, destination and border.

Note
At least one of output_x or output_y must be set.
Parameters
[in]inputSource tensor. Data types supported: U8.
[out]output_x(Optional) Destination tensor for the X gradient, Data types supported: S16.
[out]output_y(Optional) Destination tensor for the Y gradient, Data types supported: S16.
[in]border_undefinedTrue if the border mode is undefined. False if it's replicate or constant.

Definition at line 48 of file CLScharr3x3Kernel.cpp.

References CLKernelLibrary::get().

49 {
50  configure(CLKernelLibrary::get().get_compile_context(), input, output_x, output_y, border_undefined);
51 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
Initialise the kernel&#39;s source, destination and border.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output_x,
ICLTensor output_y,
bool  border_undefined 
)

Initialise the kernel's source, destination and border.

Note
At least one of output_x or output_y must be set.
Parameters
[in]compile_contextThe compile context to be used.
[in]inputSource tensor. Data types supported: U8.
[out]output_x(Optional) Destination tensor for the X gradient, Data types supported: S16.
[out]output_y(Optional) Destination tensor for the Y gradient, Data types supported: S16.
[in]border_undefinedTrue if the border mode is undefined. False if it's replicate or constant.

Definition at line 53 of file CLScharr3x3Kernel.cpp.

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, CLScharr3x3Kernel::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::S16, BorderSize::top, arm_compute::U8, arm_compute::update_window_and_padding(), and ITensorInfo::valid_region().

54 {
56  ARM_COMPUTE_ERROR_ON((output_x == nullptr) && (output_y == nullptr));
57 
58  _run_scharr_x = output_x != nullptr;
59  _run_scharr_y = output_y != nullptr;
60 
61  if(_run_scharr_x)
62  {
64  }
65 
66  if(_run_scharr_y)
67  {
69  }
70 
71  _input = input;
72  _output_x = output_x;
73  _output_y = output_y;
74 
75  // Set build options
76  std::set<std::string> build_opts;
77 
78  if(_run_scharr_x)
79  {
80  build_opts.insert("-DGRAD_X");
81  }
82 
83  if(_run_scharr_y)
84  {
85  build_opts.insert("-DGRAD_Y");
86  }
87 
88  // Create kernel
89  _kernel = create_kernel(compile_context, "scharr3x3", build_opts);
90 
91  // Configure kernel window
92  constexpr unsigned int num_elems_processed_per_iteration = 8;
93  constexpr unsigned int num_elems_read_per_iteration = 16;
94  constexpr unsigned int num_elems_written_per_iteration = 8;
95  constexpr unsigned int num_rows_read_per_iteration = 3;
96 
97  Window win = calculate_max_window(*input->info(), Steps(num_elems_processed_per_iteration), border_undefined, border_size());
98 
99  AccessWindowRectangle input_access(input->info(), -border_size().left, -border_size().top, num_elems_read_per_iteration, num_rows_read_per_iteration);
100  AccessWindowHorizontal output_x_access(output_x == nullptr ? nullptr : output_x->info(), 0, num_elems_written_per_iteration);
101  AccessWindowHorizontal output_y_access(output_y == nullptr ? nullptr : output_y->info(), 0, num_elems_written_per_iteration);
102 
103  update_window_and_padding(win, input_access, output_x_access, output_y_access);
104 
105  output_x_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
106  output_y_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
107 
108  ICLKernel::configure_internal(win);
109 }
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)
1 channel, 1 U8 per channel
#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.
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
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&#39;s metadata.
unsigned int left
left of the border
Definition: Types.h:378
1 channel, 1 S16 per channel
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
BorderSize border_size() const override
The size of the border for that kernel.
unsigned int num_elems_processed_per_iteration
Describe a multidimensional execution window.
Definition: Window.h:39

◆ operator=() [1/2]

CLScharr3x3Kernel& operator= ( const CLScharr3x3Kernel )
delete

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

◆ operator=() [2/2]

CLScharr3x3Kernel& operator= ( CLScharr3x3Kernel &&  )
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.

Reimplemented from ICLKernel.

Definition at line 111 of file CLScharr3x3Kernel.cpp.

References ICLKernel::add_2D_tensor_argument(), ICLKernel::add_2D_tensor_argument_if(), 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().

112 {
115 
117  do
118  {
119  unsigned int idx = 0;
120  add_2D_tensor_argument(idx, _input, slice);
121  add_2D_tensor_argument_if((_run_scharr_x), idx, _output_x, slice);
122  add_2D_tensor_argument_if((_run_scharr_y), idx, _output_y, slice);
123 
124  enqueue(queue, *this, slice, lws_hint());
125  }
126  while(window.slide_window_slice_2D(slice));
127 }
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:283
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void add_2D_tensor_argument_if(bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 2D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx ...
Definition: ICLKernel.h:159
void enqueue(IGCKernel &kernel, const Window &window, const gles::NDRange &lws=gles::NDRange(1U, 1U, 1U))
Add the kernel to the command queue with the given window.
Definition: IGCKernel.cpp:41
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:276
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:323
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
void add_2D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 2D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:148
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

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