Compute Library
 21.02
CLGradientKernel Class Reference

OpenCL kernel to perform Gradient computation. More...

#include <CLCannyEdgeKernel.h>

Collaboration diagram for CLGradientKernel:
[legend]

Public Member Functions

 CLGradientKernel ()
 Constructor. More...
 
 CLGradientKernel (const CLGradientKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLGradientKerneloperator= (const CLGradientKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
void configure (const ICLTensor *gx, const ICLTensor *gy, ICLTensor *magnitude, ICLTensor *phase, int32_t norm_type)
 Initialise the kernel's sources, destinations and border mode. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *gx, const ICLTensor *gy, ICLTensor *magnitude, ICLTensor *phase, int32_t norm_type)
 Initialise the kernel's sources, destinations 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...
 
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...
 
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 Gradient computation.

Definition at line 35 of file CLCannyEdgeKernel.h.

Constructor & Destructor Documentation

◆ CLGradientKernel() [1/2]

Constructor.

Definition at line 37 of file CLCannyEdgeKernel.cpp.

38  : _gx(nullptr), _gy(nullptr), _magnitude(nullptr), _phase(nullptr)
39 {
40 }

◆ CLGradientKernel() [2/2]

CLGradientKernel ( const CLGradientKernel )
delete

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

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLTensor gx,
const ICLTensor gy,
ICLTensor magnitude,
ICLTensor phase,
int32_t  norm_type 
)

Initialise the kernel's sources, destinations and border mode.

Note
gx, gy and mag must all be the same size (either 16 or 32).
Parameters
[in]gxSource tensor - Gx component. Data types supported: S16/S32.
[in]gySource tensor - Gy component. Data types supported: Same as gx.
[out]magnitudeDestination tensor - Magnitude. Data types supported: U16/U32. Must match the pixel size of gx, gy.
[out]phaseDestination tensor - Quantized phase. Data types supported: U8.
[in]norm_typeNormalization type. if 1, L1-Norm otherwise L2-Norm.

Definition at line 42 of file CLCannyEdgeKernel.cpp.

References CLKernelLibrary::get().

43 {
44  configure(CLKernelLibrary::get().get_compile_context(), gx, gy, magnitude, phase, norm_type);
45 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLTensor *gx, const ICLTensor *gy, ICLTensor *magnitude, ICLTensor *phase, int32_t norm_type)
Initialise the kernel&#39;s sources, destinations and border mode.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor gx,
const ICLTensor gy,
ICLTensor magnitude,
ICLTensor phase,
int32_t  norm_type 
)

Initialise the kernel's sources, destinations and border mode.

Note
gx, gy and mag must all be the same size (either 16 or 32).
Parameters
[in]compile_contextThe compile context to be used.
[in]gxSource tensor - Gx component. Data types supported: S16/S32.
[in]gySource tensor - Gy component. Data types supported: Same as gx.
[out]magnitudeDestination tensor - Magnitude. Data types supported: U16/U32. Must match the pixel size of gx, gy.
[out]phaseDestination tensor - Quantized phase. Data types supported: U8.
[in]norm_typeNormalization type. if 1, L1-Norm otherwise L2-Norm.

Definition at line 47 of file CLCannyEdgeKernel.cpp.

References ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, ARM_COMPUTE_ERROR_ON_MSG, arm_compute::calculate_max_window(), arm_compute::create_kernel(), arm_compute::data_size_from_type(), ITensorInfo::data_type(), ITensorInfo::dimension(), arm_compute::get_cl_type_from_data_type(), ITensor::info(), kernel_name, arm_compute::lower_string(), arm_compute::test::validation::reference::magnitude(), num_elems_processed_per_iteration, arm_compute::test::validation::reference::phase(), arm_compute::S16, arm_compute::S32, arm_compute::string_from_data_type(), 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().

48 {
54  "Gx and Gy must have the same pixel size");
56  "Mag must have the same pixel size as Gx and Gy");
57 
58  _gx = gx;
59  _gy = gy;
60  _magnitude = magnitude;
61  _phase = phase;
62 
63  // Create build opts
64  std::set<std::string> built_opts;
65  built_opts.emplace("-DDATA_TYPE_IN=" + get_cl_type_from_data_type(gx->info()->data_type()));
66  built_opts.emplace("-DDATA_TYPE_OUT=" + get_cl_type_from_data_type(gx->info()->data_type()));
67 
68  // Create kernel
69  const std::string kernel_name = (norm_type == 1) ? std::string("combine_gradients_L1") : std::string("combine_gradients_L2");
70  _kernel = create_kernel(compile_context, kernel_name, built_opts);
71 
72  // Configure kernel window
73  constexpr unsigned int num_elems_processed_per_iteration = 4;
74 
75  Window win = calculate_max_window(*_gx->info(), Steps(num_elems_processed_per_iteration));
76 
81 
82  update_window_and_padding(win, gx_access, gy_access, mag_access, phase_access);
83 
84  mag_access.set_valid_region(win, _gx->info()->valid_region());
85  phase_access.set_valid_region(win, _gx->info()->valid_region());
86 
87  ICLKernel::configure_internal(win);
88 
89  // Set config_id for enabling LWS tuning
90  _config_id = kernel_name;
91  _config_id += "_";
92  _config_id += lower_string(string_from_data_type(gx->info()->data_type()));
93  _config_id += "_";
94  _config_id += support::cpp11::to_string(gx->info()->dimension(0));
95  _config_id += "_";
96  _config_id += support::cpp11::to_string(gx->info()->dimension(1));
97 }
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
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.
SimpleTensor< uint8_t > phase(const SimpleTensor< T > &gx, const SimpleTensor< T > &gy, PhaseType phase_type)
Definition: Phase.cpp:35
1 channel, 1 U16 per channel
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:350
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
1 channel, 1 S32 per channel
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
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:135
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: WindowHelpers.h:46
1 channel, 1 U32 per channel
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
Implementation of a row access pattern.
std::string kernel_name
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:37
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
size_t data_size_from_type(DataType data_type)
The size in bytes of the data type.
Definition: Utils.h:106
1 channel, 1 S16 per channel
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
unsigned int num_elems_processed_per_iteration
Describe a multidimensional execution window.
Definition: Window.h:39
SimpleTensor< T > magnitude(const SimpleTensor< T > &gx, const SimpleTensor< T > &gy, MagnitudeType magnitude_type)
Definition: Magnitude.cpp:35

◆ operator=()

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

Reimplemented from ICLKernel.

Definition at line 99 of file CLCannyEdgeKernel.cpp.

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().

100 {
103 
105  do
106  {
107  unsigned int idx = 0;
108  add_2D_tensor_argument(idx, _gx, slice);
109  add_2D_tensor_argument(idx, _gy, slice);
110  add_2D_tensor_argument(idx, _magnitude, slice);
111  add_2D_tensor_argument(idx, _phase, slice);
112  enqueue(queue, *this, slice, lws_hint());
113  }
114  while(window.slide_window_slice_2D(slice));
115 }
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 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: