Compute Library
 19.08
GCAbsoluteDifferenceKernel Class Reference

Interface for the absolute difference kernel. More...

#include <GCAbsoluteDifferenceKernel.h>

Collaboration diagram for GCAbsoluteDifferenceKernel:
[legend]

Public Member Functions

 GCAbsoluteDifferenceKernel ()
 Default constructor. More...
 
 GCAbsoluteDifferenceKernel (const GCAbsoluteDifferenceKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
GCAbsoluteDifferenceKerneloperator= (const GCAbsoluteDifferenceKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 GCAbsoluteDifferenceKernel (GCAbsoluteDifferenceKernel &&)=default
 Allow instances of this class to be moved. More...
 
GCAbsoluteDifferenceKerneloperator= (GCAbsoluteDifferenceKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~GCAbsoluteDifferenceKernel ()=default
 Default destructor. More...
 
void configure (const IGCTensor *input1, const IGCTensor *input2, IGCTensor *output)
 Set the inputs and output images. More...
 
void run (const Window &window) override
 Enqueue the OpenGL ES shader to process the given window. More...
 
- Public Member Functions inherited from IGCKernel
 IGCKernel ()
 Constructor. More...
 
GCKernelkernel ()
 Returns a reference to the GLES kernel of this object. More...
 
void add_1D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, 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_2D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, 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_3D_tensor_argument (unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
unsigned int num_arguments_per_1D_tensor () const
 Returns the number of arguments enqueued per 1D tensor object. More...
 
unsigned int num_arguments_per_2D_tensor () const
 Returns the number of arguments enqueued per 2D tensor object. More...
 
unsigned int num_arguments_per_3D_tensor () const
 Returns the number of arguments enqueued per 3D tensor object. More...
 
void set_lws_hint (gles::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. 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...
 

Detailed Description

Interface for the absolute difference kernel.

Absolute difference is computed by:

\[ output(x,y) = | input1(x,y) - input2(x,y) | \]

Definition at line 38 of file GCAbsoluteDifferenceKernel.h.

Constructor & Destructor Documentation

◆ GCAbsoluteDifferenceKernel() [1/3]

Default constructor.

Definition at line 42 of file GCAbsoluteDifferenceKernel.cpp.

43  : _input1(nullptr), _input2(nullptr), _output(nullptr)
44 {
45 }

◆ GCAbsoluteDifferenceKernel() [2/3]

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

◆ GCAbsoluteDifferenceKernel() [3/3]

Allow instances of this class to be moved.

◆ ~GCAbsoluteDifferenceKernel()

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const IGCTensor input1,
const IGCTensor input2,
IGCTensor output 
)

Set the inputs and output images.

Parameters
[in]input1Source tensor. Data types supported: U8
[in]input2Source tensor. Data types supported: U8
[out]outputDestination tensor. Data types supported: U8

Definition at line 47 of file GCAbsoluteDifferenceKernel.cpp.

48 {
52  ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(input1, input2, output);
53 
54  _input1 = input1;
55  _input2 = input2;
56  _output = output;
57 
58  constexpr unsigned int num_elems_processed_per_iteration = 4;
59 
60  // Set kernel build options
61  std::set<std::string> build_opts;
62  build_opts.emplace("#define LOCAL_SIZE_X " + support::cpp11::to_string(1));
63  build_opts.emplace("#define LOCAL_SIZE_Y " + support::cpp11::to_string(1));
64  build_opts.emplace("#define LOCAL_SIZE_Z " + support::cpp11::to_string(1));
65 
66  // Create kernel
67  _kernel = static_cast<GCKernel>(GCKernelLibrary::get().create_kernel("absdiff", build_opts));
68 
69  // Configure kernel window
70  Window win = calculate_max_window(*input1->info(), Steps(num_elems_processed_per_iteration));
71 
72  AccessWindowRectangle input1_access(input1->info(), 0, 0, 4, 1);
73  AccessWindowRectangle input2_access(input2->info(), 0, 0, 4, 1);
74  AccessWindowRectangle output_access(output->info(), 0, 0, 4, 1);
75 
76  update_window_and_padding(win, input1_access, input2_access, output_access);
77 
79  input2->info()->valid_region());
80 
81  output_access.set_valid_region(win, valid_region);
82 
83  IGCKernel::configure(win);
84 }
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:543
1 channel, 1 U8 per channel
std::string to_string(T &&value)
Convert integer and float values to string.
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window for a given tensor shape and border setting.
Definition: Helpers.cpp:28
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
Implementation of a rectangular access pattern.
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: Helpers.h:402
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
ValidRegion intersect_valid_regions(const Ts &... regions)
Intersect multiple valid regions.
Definition: Helpers.h:503
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
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:789
static GCKernelLibrary & get()
Get the static instance of GCKernelLibrary.
Container for valid region of a window.
Definition: Types.h:174
Describe a multidimensional execution window.
Definition: Window.h:39

References ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES, arm_compute::calculate_max_window(), arm_compute::create_kernel(), GCKernelLibrary::get(), ITensor::info(), arm_compute::intersect_valid_regions(), arm_compute::support::cpp11::to_string(), arm_compute::U8, arm_compute::update_window_and_padding(), arm_compute::test::validation::valid_region, and ITensorInfo::valid_region().

◆ operator=() [1/2]

GCAbsoluteDifferenceKernel& operator= ( const GCAbsoluteDifferenceKernel )
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)
overridevirtual

Enqueue the OpenGL ES shader to process the given window.

Parameters
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).

Implements IGCKernel.

Definition at line 86 of file GCAbsoluteDifferenceKernel.cpp.

87 {
90 
91  _kernel.use();
92 
94  do
95  {
96  unsigned int idx = 0;
97  unsigned int binding = 1; // SSBO binding starts from 1.
98  add_2D_tensor_argument(idx, _input1, binding++, slice);
99  add_2D_tensor_argument(idx, _input2, binding++, slice);
100  add_2D_tensor_argument(idx, _output, binding++, slice);
101 
102  _kernel.update_shader_params();
103 
104  enqueue(*this, slice);
105  }
107 }
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
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:307
void add_2D_tensor_argument(unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, const Window &window)
Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx.
Definition: IGCKernel.cpp:127
#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
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References IGCKernel::add_2D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), Window::first_slice_window_2D(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_2D(), and IKernel::window().


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