Compute Library
 21.02
CLLKTrackerInitKernel Class Reference

Interface to run the initialization step of LKTracker. More...

#include <CLLKTrackerKernel.h>

Collaboration diagram for CLLKTrackerInitKernel:
[legend]

Public Member Functions

void configure (const ICLKeyPointArray *old_points, const ICLKeyPointArray *new_points_estimates, ICLLKInternalKeypointArray *old_points_internal, ICLLKInternalKeypointArray *new_points_internal, bool use_initial_estimate, size_t level, size_t num_levels, float pyramid_scale)
 Initialise the kernel input and output. More...
 
void configure (const CLCompileContext &compile_context, const ICLKeyPointArray *old_points, const ICLKeyPointArray *new_points_estimates, ICLLKInternalKeypointArray *old_points_internal, ICLLKInternalKeypointArray *new_points_internal, bool use_initial_estimate, size_t level, size_t num_levels, float pyramid_scale)
 Initialise the kernel input and output. 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

Interface to run the initialization step of LKTracker.

Definition at line 39 of file CLLKTrackerKernel.h.

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLKeyPointArray old_points,
const ICLKeyPointArray new_points_estimates,
ICLLKInternalKeypointArray old_points_internal,
ICLLKInternalKeypointArray new_points_internal,
bool  use_initial_estimate,
size_t  level,
size_t  num_levels,
float  pyramid_scale 
)

Initialise the kernel input and output.

Parameters
[in]old_pointsPointer to the ICLKeyPointArray storing old key points
[in]new_points_estimatesPointer to the ICLKeyPointArray storing new estimates key points
[out]old_points_internalPointer to the array of internal CLLKInternalKeypoint old points
[out]new_points_internalPointer to the array of internal CLLKInternalKeypoint new points
[in]use_initial_estimateThe flag to indicate whether the initial estimated position should be used
[in]levelThe pyramid level
[in]num_levelsThe number of pyramid levels
[in]pyramid_scaleScale factor used for generating the pyramid

Definition at line 40 of file CLLKTrackerKernel.cpp.

References CLKernelLibrary::get().

Referenced by CLLKTrackerFinalizeKernel::configure().

43 {
44  configure(CLKernelLibrary::get().get_compile_context(), old_points, new_points_estimates, old_points_internal, new_points_internal, use_initial_estimate, level, num_levels, pyramid_scale);
45 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLKeyPointArray *old_points, const ICLKeyPointArray *new_points_estimates, ICLLKInternalKeypointArray *old_points_internal, ICLLKInternalKeypointArray *new_points_internal, bool use_initial_estimate, size_t level, size_t num_levels, float pyramid_scale)
Initialise the kernel input and output.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLKeyPointArray old_points,
const ICLKeyPointArray new_points_estimates,
ICLLKInternalKeypointArray old_points_internal,
ICLLKInternalKeypointArray new_points_internal,
bool  use_initial_estimate,
size_t  level,
size_t  num_levels,
float  pyramid_scale 
)

Initialise the kernel input and output.

Parameters
[in]compile_contextThe compile context to be used.
[in]old_pointsPointer to the ICLKeyPointArray storing old key points
[in]new_points_estimatesPointer to the ICLKeyPointArray storing new estimates key points
[out]old_points_internalPointer to the array of internal CLLKInternalKeypoint old points
[out]new_points_internalPointer to the array of internal CLLKInternalKeypoint new points
[in]use_initial_estimateThe flag to indicate whether the initial estimated position should be used
[in]levelThe pyramid level
[in]num_levelsThe number of pyramid levels
[in]pyramid_scaleScale factor used for generating the pyramid

Definition at line 47 of file CLLKTrackerKernel.cpp.

References ARM_COMPUTE_ERROR_ON, ICLArray< T >::cl_buffer(), arm_compute::create_kernel(), Window::DimX, Window::DimY, kernel_name, IArray< T >::num_values(), arm_compute::test::validation::scale, Window::set(), and IKernel::window().

51 {
52  ARM_COMPUTE_ERROR_ON(old_points == nullptr);
53  ARM_COMPUTE_ERROR_ON(old_points_internal == nullptr);
54  ARM_COMPUTE_ERROR_ON(new_points_internal == nullptr);
55 
56  const float scale = std::pow(pyramid_scale, level);
57 
58  // Create kernel
59  std::string kernel_name = "init_level";
60  if(level == (num_levels - 1))
61  {
62  kernel_name += (use_initial_estimate) ? std::string("_max_initial_estimate") : std::string("_max");
63  }
64  _kernel = create_kernel(compile_context, kernel_name);
65 
66  // Set static kernel arguments
67  unsigned int idx = 0;
68  if(level == (num_levels - 1))
69  {
70  _kernel.setArg(idx++, old_points->cl_buffer());
71  if(use_initial_estimate)
72  {
73  _kernel.setArg(idx++, new_points_estimates->cl_buffer());
74  }
75  }
76  _kernel.setArg(idx++, old_points_internal->cl_buffer());
77  _kernel.setArg(idx++, new_points_internal->cl_buffer());
78  _kernel.setArg<cl_float>(idx++, scale);
79 
80  // Configure kernel window
81  Window window;
82  window.set(Window::DimX, Window::Dimension(0, old_points->num_values(), 1));
83  window.set(Window::DimY, Window::Dimension(0, 1, 1));
84  ICLKernel::configure_internal(window);
85 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
#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
Describe one of the image&#39;s dimensions with a start, end and step.
Definition: Window.h:77
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
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
size_t num_values() const
Number of values currently stored in the array.
Definition: IArray.h:68
std::string kernel_name
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:49
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
virtual const cl::Buffer & cl_buffer() const =0
Interface to be implemented by the child class to return a reference to the OpenCL buffer containing ...
Describe a multidimensional execution window.
Definition: Window.h:39

◆ 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 87 of file CLLKTrackerKernel.cpp.

References ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), ICLKernel::lws_hint(), and IKernel::window().

88 {
91 
92  enqueue(queue, *this, window, lws_hint());
93 }
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
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205

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