Compute Library
 21.02
CLWarpAffineKernel Class Reference

Interface for the warp affine kernel. More...

#include <CLWarpAffineKernel.h>

Collaboration diagram for CLWarpAffineKernel:
[legend]

Public Member Functions

void configure (const ICLTensor *input, ICLTensor *output, const std::array< float, 9 > &matrix, InterpolationPolicy policy)
 Initialize the function's source, destination, interpolation policy and border_mode. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const std::array< float, 9 > &matrix, InterpolationPolicy policy)
 Initialize the function's source, destination, interpolation policy and border_mode. More...
 
BorderSize border_size () const override
 The size of the border for that kernel. More...
 
- Public Member Functions inherited from ICLSimple2DKernel
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 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...
 
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 warp affine kernel.

Definition at line 35 of file CLWarpAffineKernel.h.

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 58 of file CLWarpAffineKernel.cpp.

Referenced by CLWarpAffineKernel::configure().

59 {
60  return BorderSize(1);
61 }

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output,
const std::array< float, 9 > &  matrix,
InterpolationPolicy  policy 
)

Initialize the function's source, destination, interpolation policy and border_mode.

Parameters
[in]inputSource tensor. Data types supported: U8.
[out]outputDestination tensor, Data types supported: U8.
[in]matrixThe perspective matrix. Must be 2x3 of type float The matrix argument requires 9 values, the last 3 values are ignored.
[in]policyThe interpolation type.

Definition at line 63 of file CLWarpAffineKernel.cpp.

References CLKernelLibrary::get().

64 {
65  configure(CLKernelLibrary::get().get_compile_context(), input, output, matrix, policy);
66 }
void configure(const ICLTensor *input, ICLTensor *output, const std::array< float, 9 > &matrix, InterpolationPolicy policy)
Initialize the function&#39;s source, destination, interpolation policy and border_mode.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output,
const std::array< float, 9 > &  matrix,
InterpolationPolicy  policy 
)

Initialize the function's source, destination, interpolation policy and border_mode.

Parameters
[in]compile_contextThe compile context to be used.
[in]inputSource tensor. Data types supported: U8.
[out]outputDestination tensor, Data types supported: U8.
[in]matrixThe perspective matrix. Must be 2x3 of type float The matrix argument requires 9 values, the last 3 values are ignored.
[in]policyThe interpolation type.

Definition at line 68 of file CLWarpAffineKernel.cpp.

References arm_compute::AREA, ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, CLWarpAffineKernel::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::get_cl_type_from_data_type(), ITensor::info(), arm_compute::test::validation::input, kernel_name, BorderSize::left, arm_compute::lower_string(), ICLKernel::num_arguments_per_2D_tensor(), num_elems_processed_per_iteration, BorderSize::right, arm_compute::string_from_data_type(), arm_compute::string_from_interpolation_policy(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), arm_compute::utility::tolower(), BorderSize::top, arm_compute::U8, and arm_compute::update_window_and_padding().

69 {
73 
74  _input = input;
75  _output = output;
76 
77  // Create build options
78  std::set<std::string> options;
79  options_add_matrix(options, matrix);
80  options.emplace(("-DDATA_TYPE=" + get_cl_type_from_data_type(input->info()->data_type())));
81 
82  // Create kernel
83  std::string interpolation_name = string_from_interpolation_policy(policy);
84  std::transform(interpolation_name.begin(), interpolation_name.end(), interpolation_name.begin(), ::tolower);
85  const std::string kernel_name = "warp_affine_" + interpolation_name;
86  _kernel = create_kernel(compile_context, kernel_name, options);
87 
88  // Set static kernel arguments
89  unsigned int idx = 2 * num_arguments_per_2D_tensor(); //Skip the input and output parameters
90  _kernel.setArg<cl_int>(idx++, input->info()->dimension(0));
91  _kernel.setArg<cl_int>(idx++, input->info()->dimension(1));
92 
93  // Configure kernel window
94  constexpr unsigned int num_elems_processed_per_iteration = 4;
95 
96  Window win = calculate_max_window(*output->info(), Steps(num_elems_processed_per_iteration));
97 
98  int total_right = ceil_to_multiple(input->info()->dimension(0), num_elems_processed_per_iteration);
99  const int access_right = total_right + (((total_right - input->info()->dimension(0)) == 0) ? border_size().right : 0);
100 
101  AccessWindowStatic input_access(input->info(), -border_size().left, -border_size().top, access_right, input->info()->dimension(1) + border_size().bottom);
102  AccessWindowHorizontal output_access(output->info(), 0, num_elems_processed_per_iteration);
103 
104  update_window_and_padding(win, input_access, output_access);
105 
106  output_access.set_valid_region(win, ValidRegion(Coordinates(), output->info()->tensor_shape()));
107 
108  ICLKernel::configure_internal(win);
109 
110  // Set config_id for enabling LWS tuning
111  _config_id = kernel_name;
112  _config_id += "_";
113  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
114  _config_id += "_";
115  _config_id += support::cpp11::to_string(input->info()->dimension(0));
116  _config_id += "_";
117  _config_id += support::cpp11::to_string(input->info()->dimension(1));
118  _config_id += "_";
119  _config_id += support::cpp11::to_string(input->info()->dimension(2));
120  _config_id += "_";
121  _config_id += support::cpp11::to_string(input->info()->dimension(3));
122  _config_id += "_";
123  _config_id += support::cpp11::to_string(output->info()->dimension(0));
124  _config_id += "_";
125  _config_id += support::cpp11::to_string(output->info()->dimension(1));
126  _config_id += "_";
127  _config_id += support::cpp11::to_string(output->info()->dimension(2));
128  _config_id += "_";
129  _config_id += support::cpp11::to_string(output->info()->dimension(3));
130  _config_id += "_";
131  _config_id += lower_string(string_from_interpolation_policy(policy));
132 }
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
std::string to_string(T &&value)
Convert integer and float values to string.
#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
unsigned int bottom
bottom of the border
Definition: Types.h:377
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:350
BorderSize border_size() const override
The size of the border for that kernel.
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
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
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
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
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

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