Compute Library
 19.08
CLGaussianPyramidHorKernel Class Reference

OpenCL kernel to perform a Gaussian filter and half scaling across width (horizontal pass) More...

#include <CLGaussianPyramidKernel.h>

Collaboration diagram for CLGaussianPyramidHorKernel:
[legend]

Public Member Functions

 CLGaussianPyramidHorKernel ()
 Default constructor. More...
 
 CLGaussianPyramidHorKernel (const CLGaussianPyramidHorKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLGaussianPyramidHorKerneloperator= (const CLGaussianPyramidHorKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLGaussianPyramidHorKernel (CLGaussianPyramidHorKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLGaussianPyramidHorKerneloperator= (CLGaussianPyramidHorKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLGaussianPyramidHorKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output)
 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...
 
BorderSize border_size () const override
 The size of the border for that kernel. More...
 
- Public Member Functions inherited from ICLSimpleKernel
 ICLSimpleKernel ()
 Constructor. More...
 
 ICLSimpleKernel (const ICLSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICLSimpleKerneloperator= (const ICLSimpleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICLSimpleKernel (ICLSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
ICLSimpleKerneloperator= (ICLSimpleKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~ICLSimpleKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, unsigned int num_elems_processed_per_iteration, bool border_undefined=false, const BorderSize &border_size=BorderSize())
 Configure the 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...
 
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...
 
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 Gaussian filter and half scaling across width (horizontal pass)

Definition at line 34 of file CLGaussianPyramidKernel.h.

Constructor & Destructor Documentation

◆ CLGaussianPyramidHorKernel() [1/3]

Default constructor.

Definition at line 34 of file CLGaussianPyramidKernel.cpp.

35  : _l2_load_offset(0)
36 {
37 }

◆ CLGaussianPyramidHorKernel() [2/3]

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

◆ CLGaussianPyramidHorKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLGaussianPyramidHorKernel()

Default destructor.

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 39 of file CLGaussianPyramidKernel.cpp.

40 {
41  return BorderSize{ 0, 2 };
42 }
Container for 2D border size.
Definition: Types.h:259

Referenced by CLGaussianPyramidHorKernel::configure().

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output 
)

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

Parameters
[in]inputSource tensor. Data types supported: U8.
[out]outputDestination tensor. Output should have half the input width. Data types supported: U16.

Definition at line 44 of file CLGaussianPyramidKernel.cpp.

45 {
48  ARM_COMPUTE_ERROR_ON(input->info()->dimension(1) != output->info()->dimension(1));
49 
50  for(size_t i = 2; i < Coordinates::num_max_dimensions; ++i)
51  {
52  ARM_COMPUTE_ERROR_ON(input->info()->dimension(i) != output->info()->dimension(i));
53  }
54 
55  _input = input;
56  _output = output;
57 
58  // Create kernel
59  const std::string kernel_name = std::string("gaussian1x5_sub_x");
60  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name));
61 
62  // Configure kernel window
63  constexpr unsigned int num_elems_processed_per_iteration = 16;
64  constexpr unsigned int num_elems_read_per_iteration = 20;
65  constexpr unsigned int num_elems_written_per_iteration = 8;
66  const float scale_x = static_cast<float>(output->info()->dimension(0)) / input->info()->dimension(0);
67 
68  Window win = calculate_max_window_horizontal(*input->info(), Steps(num_elems_processed_per_iteration));
69  AccessWindowHorizontal output_access(output->info(), 0, num_elems_written_per_iteration, scale_x);
70 
71  // Sub sampling selects odd pixels (1, 3, 5, ...) for images with even
72  // width and even pixels (0, 2, 4, ...) for images with odd width. (Whether
73  // a pixel is even or odd is determined based on the tensor shape not the
74  // valid region!)
75  // Thus the offset from which the first pixel (L2) for the convolution is
76  // loaded depends on the anchor and shape of the valid region.
77  // In the case of an even shape (= even image width) we need to load L2
78  // from -2 if the anchor is odd and from -1 if the anchor is even. That
79  // makes sure that L2 is always loaded from an odd pixel.
80  // On the other hand, for an odd shape (= odd image width) we need to load
81  // L2 from -1 if the anchor is odd and from -2 if the anchor is even to
82  // achieve the opposite effect.
83  // The condition can be simplified to checking whether anchor + shape is
84  // odd (-2) or even (-1) as only adding an odd and an even number will have
85  // an odd result.
86  _l2_load_offset = -border_size().left;
87 
88  if((_input->info()->valid_region().anchor[0] + _input->info()->valid_region().shape[0]) % 2 == 0)
89  {
90  _l2_load_offset += 1;
91  }
92 
94  AccessWindowHorizontal(input->info(), _l2_load_offset, num_elems_read_per_iteration),
95  output_access);
96 
97  output->info()->set_valid_region(ValidRegion(Coordinates(), output->info()->tensor_shape()));
98 
99  ICLKernel::configure_internal(win);
100 
101  // Set config_id for enabling LWS tuning
102  _config_id = kernel_name;
103  _config_id += "_";
104  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
105  _config_id += "_";
106  _config_id += support::cpp11::to_string(input->info()->dimension(0));
107  _config_id += "_";
108  _config_id += support::cpp11::to_string(input->info()->dimension(1));
109  _config_id += "_";
110  _config_id += support::cpp11::to_string(output->info()->dimension(0));
111  _config_id += "_";
112  _config_id += support::cpp11::to_string(output->info()->dimension(1));
113 }
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.
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:337
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
virtual void set_valid_region(const ValidRegion &valid_region)=0
Set the valid region of the tensor.
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
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Coordinates of an item.
Definition: Coordinates.h:37
Implementation of a row access pattern.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
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
unsigned int left
left of the border
Definition: Types.h:342
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:789
BorderSize border_size() const override
The size of the border for that kernel.
Container for valid region of a window.
Definition: Types.h:174
static constexpr size_t num_max_dimensions
Number of dimensions the tensor has.
Definition: Dimensions.h:45
Describe a multidimensional execution window.
Definition: Window.h:39
Window calculate_max_window_horizontal(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window used by a horizontal kernel for a given tensor shape and border setting.
Definition: Helpers.cpp:131

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, CLGaussianPyramidHorKernel::border_size(), arm_compute::calculate_max_window_horizontal(), arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), CLKernelLibrary::get(), ITensor::info(), BorderSize::left, arm_compute::lower_string(), Dimensions< int >::num_max_dimensions, ITensorInfo::set_valid_region(), arm_compute::string_from_data_type(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), arm_compute::U16, arm_compute::U8, and arm_compute::update_window_and_padding().

◆ operator=() [1/2]

CLGaussianPyramidHorKernel& operator= ( const CLGaussianPyramidHorKernel )
delete

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

◆ operator=() [2/2]

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.

Implements ICLKernel.

Definition at line 115 of file CLGaussianPyramidKernel.cpp.

116 {
119 
120  Window win_in(window);
121  win_in.shift(Window::DimX, _l2_load_offset);
122 
123  //The output is half the width of the input:
124  Window win_out(window);
125  win_out.scale(Window::DimX, 0.5f);
126 
127  Window slice_in = win_in.first_slice_window_2D();
128  Window slice_out = win_out.first_slice_window_2D();
129 
130  do
131  {
132  unsigned int idx = 0;
133  add_2D_tensor_argument(idx, _input, slice_in);
134  add_2D_tensor_argument(idx, _output, slice_out);
135  enqueue(queue, *this, slice_out, lws_hint());
136  }
137  while(win_in.slide_window_slice_2D(slice_in) && win_out.slide_window_slice_2D(slice_out));
138 }
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
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
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

References ICLKernel::add_2D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::DimX, arm_compute::enqueue(), Window::first_slice_window_2D(), ICLKernel::lws_hint(), Window::scale(), Window::shift(), Window::slide_window_slice_2D(), and IKernel::window().


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