Compute Library
 21.02
CLRemapKernel Class Reference

OpenCL kernel to perform a remap on a tensor. More...

#include <CLRemapKernel.h>

Collaboration diagram for CLRemapKernel:
[legend]

Public Member Functions

 CLRemapKernel ()
 Default constructor. More...
 
 CLRemapKernel (const CLRemapKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLRemapKerneloperator= (const CLRemapKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLRemapKernel (CLRemapKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLRemapKerneloperator= (CLRemapKernel &&)=default
 Allow instances of this class to be moved. More...
 
void configure (const ICLTensor *input, const ICLTensor *map_x, const ICLTensor *map_y, ICLTensor *output, InterpolationPolicy policy, bool border_undefined)
 Initialize the kernel's input, output and border mode. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *map_x, const ICLTensor *map_y, ICLTensor *output, InterpolationPolicy policy, bool border_undefined)
 Initialize the kernel's input, output 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...
 
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

OpenCL kernel to perform a remap on a tensor.

Definition at line 35 of file CLRemapKernel.h.

Constructor & Destructor Documentation

◆ CLRemapKernel() [1/3]

Default constructor.

Definition at line 39 of file CLRemapKernel.cpp.

40  : _input(nullptr), _output(nullptr), _map_x(nullptr), _map_y(nullptr)
41 {
42 }

◆ CLRemapKernel() [2/3]

CLRemapKernel ( const CLRemapKernel )
delete

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

◆ CLRemapKernel() [3/3]

CLRemapKernel ( CLRemapKernel &&  )
default

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 44 of file CLRemapKernel.cpp.

Referenced by CLRemapKernel::configure().

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

◆ configure() [1/2]

void configure ( const ICLTensor input,
const ICLTensor map_x,
const ICLTensor map_y,
ICLTensor output,
InterpolationPolicy  policy,
bool  border_undefined 
)

Initialize the kernel's input, output and border mode.

Parameters
[in]inputSource tensor. Data types supported: U8.
[in]map_xMap for X coordinates. Data types supported: F32.
[in]map_yMap for Y coordinates. Data types supported: F32.
[out]outputDestination tensor. Data types supported: U8. All but the lowest two dimensions must be the same size as in the input tensor, i.e. remapping is only performed within the XY-plane.
[in]policyThe interpolation type.
[in]border_undefinedTrue if the border mode is undefined. False if it's replicate or constant.

Definition at line 49 of file CLRemapKernel.cpp.

References CLKernelLibrary::get().

50 {
51  configure(CLKernelLibrary::get().get_compile_context(), input, map_x, map_y, output, policy, border_undefined);
52 }
void configure(const ICLTensor *input, const ICLTensor *map_x, const ICLTensor *map_y, ICLTensor *output, InterpolationPolicy policy, bool border_undefined)
Initialize the kernel&#39;s input, output and border mode.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
const ICLTensor map_x,
const ICLTensor map_y,
ICLTensor output,
InterpolationPolicy  policy,
bool  border_undefined 
)

Initialize the kernel's input, output and border mode.

Parameters
[in]compile_contextThe compile context to be used.
[in]inputSource tensor. Data types supported: U8.
[in]map_xMap for X coordinates. Data types supported: F32.
[in]map_yMap for Y coordinates. Data types supported: F32.
[out]outputDestination tensor. Data types supported: U8. All but the lowest two dimensions must be the same size as in the input tensor, i.e. remapping is only performed within the XY-plane.
[in]policyThe interpolation type.
[in]border_undefinedTrue if the border mode is undefined. False if it's replicate or constant.

Definition at line 54 of file CLRemapKernel.cpp.

References arm_compute::AREA, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, ARM_COMPUTE_ERROR_ON_MSG, ARM_COMPUTE_UNUSED, CLRemapKernel::border_size(), BorderSize::bottom, arm_compute::calculate_max_window(), arm_compute::ceil_to_multiple(), arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), arm_compute::F32, arm_compute::get_cl_type_from_data_type(), ITensor::info(), arm_compute::test::validation::input, kernel_name, BorderSize::left, ICLKernel::num_arguments_per_2D_tensor(), num_elems_processed_per_iteration, BorderSize::right, arm_compute::string_from_interpolation_policy(), ITensorInfo::tensor_shape(), arm_compute::utility::tolower(), BorderSize::top, arm_compute::U8, and arm_compute::update_window_and_padding().

56 {
61  ARM_COMPUTE_ERROR_ON_MSG(policy == InterpolationPolicy::AREA, "Area interpolation is not supported!");
62  ARM_COMPUTE_UNUSED(border_undefined);
63 
64  _input = input;
65  _output = output;
66  _map_x = map_x;
67  _map_y = map_y;
68 
69  // Create kernel
70  std::set<std::string> build_opts = { ("-DDATA_TYPE=" + get_cl_type_from_data_type(input->info()->data_type())) };
71  std::string interpolation_name = string_from_interpolation_policy(policy);
72  std::transform(interpolation_name.begin(), interpolation_name.end(), interpolation_name.begin(), ::tolower);
73  std::string kernel_name = "remap_" + interpolation_name;
74  _kernel = create_kernel(compile_context, kernel_name, build_opts);
75 
76  // Configure window
77  constexpr unsigned int num_elems_processed_per_iteration = 4;
78 
79  const int total_right = ceil_to_multiple(input->info()->dimension(0), num_elems_processed_per_iteration);
80  const int access_right = total_right + (((total_right - input->info()->dimension(0)) == 0) ? border_size().right : 0);
81 
82  Window win = calculate_max_window(*_output->info(), Steps(num_elems_processed_per_iteration));
83  AccessWindowStatic input_access(input->info(), -border_size().left, -border_size().top, access_right, input->info()->dimension(1) + border_size().bottom);
84 
86 
87  update_window_and_padding(win, input_access, output_access);
88 
89  output_access.set_valid_region(win, ValidRegion(Coordinates(), output->info()->tensor_shape()));
90 
91  ICLKernel::configure_internal(win);
92 
93  // Set static arguments
94  unsigned int idx = 4 * num_arguments_per_2D_tensor(); //Skip the input and output parameters
95  _kernel.setArg<cl_float>(idx++, input->info()->dimension(0));
96  _kernel.setArg<cl_float>(idx++, input->info()->dimension(1));
97 }
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)
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
1 channel, 1 U8 per channel
virtual DataType data_type() const =0
Data type used for each element of the tensor.
1 channel, 1 F32 per channel
unsigned int bottom
bottom of the border
Definition: Types.h:377
Implementation of a static rectangular access pattern.
std::string tolower(std::string string)
Convert string to lower case.
Definition: Utility.h:203
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
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
auto ceil_to_multiple(S value, T divisor) -> decltype(((value+divisor - 1)/divisor) *divisor)
Computes the smallest number larger or equal to value that is a multiple of divisor.
Definition: Utils.h:71
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
Coordinates of an item.
Definition: Coordinates.h:37
Implementation of a row access pattern.
std::string kernel_name
const std::string & string_from_interpolation_policy(InterpolationPolicy policy)
Translates a given interpolation policy to a string.
Definition: Utils.cpp:212
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.
static constexpr unsigned int num_arguments_per_2D_tensor()
Returns the number of arguments enqueued per 2D tensor object.
Definition: ICLKernel.h:206
unsigned int left
left of the border
Definition: Types.h:378
unsigned int right
right of the border
Definition: Types.h:376
Output values are determined by averaging the source pixels whose areas fall under the area of the de...
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
unsigned int num_elems_processed_per_iteration
Container for valid region of a window.
Definition: Types.h:188
BorderSize border_size() const override
The size of the border for that kernel.
Describe a multidimensional execution window.
Definition: Window.h:39

◆ operator=() [1/2]

CLRemapKernel& operator= ( const CLRemapKernel )
delete

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

◆ operator=() [2/2]

CLRemapKernel& operator= ( CLRemapKernel &&  )
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 99 of file CLRemapKernel.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 
106  do
107  {
108  unsigned int idx = 0;
109  add_2D_tensor_argument(idx, _input, slice);
110  add_2D_tensor_argument(idx, _output, slice);
111  add_2D_tensor_argument(idx, _map_x, slice);
112  add_2D_tensor_argument(idx, _map_y, slice);
113  enqueue(queue, *this, slice, lws_hint());
114  }
115  while(window.slide_window_slice_2D(slice));
116 }
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: