Compute Library
 21.02
CLSobel5x5Kernel.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2020 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
25 
32 #include "support/StringSupport.h"
33 
34 #include <set>
35 #include <string>
36 
37 using namespace arm_compute;
38 
40  : _input(nullptr), _output_x(nullptr), _output_y(nullptr), _run_sobel_x(false), _run_sobel_y(false), _border_size(0)
41 {
42 }
43 
45 {
46  return _border_size;
47 }
48 
49 void CLSobel5x5HorKernel::configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
50 {
51  configure(CLKernelLibrary::get().get_compile_context(), input, output_x, output_y, border_undefined);
52 }
53 
54 void CLSobel5x5HorKernel::configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
55 {
57  ARM_COMPUTE_ERROR_ON((output_x == nullptr) && (output_y == nullptr));
58 
59  _run_sobel_x = output_x != nullptr;
60  _run_sobel_y = output_y != nullptr;
61 
62  if(_run_sobel_x)
63  {
65  }
66 
67  if(_run_sobel_y)
68  {
70  }
71 
72  _input = input;
73  _output_x = output_x;
74  _output_y = output_y;
75  _border_size = BorderSize(border_undefined ? 0 : 2, 2);
76 
77  // Set build options
78  std::set<std::string> build_opts;
79 
80  if(_run_sobel_x)
81  {
82  build_opts.insert("-DGRAD_X");
83  }
84 
85  if(_run_sobel_y)
86  {
87  build_opts.insert("-DGRAD_Y");
88  }
89 
90  // Create kernel
91  const std::string kernel_name = std::string("sobel_separable1x5");
92  _kernel = create_kernel(compile_context, kernel_name, build_opts);
93 
94  // Configure kernel window
95  constexpr unsigned int num_elems_processed_per_iteration = 8;
96  constexpr unsigned int num_elems_read_per_iteration = 16;
97  constexpr unsigned int num_elems_written_per_iteration = 8;
98 
99  Window win = calculate_max_window_horizontal(*input->info(), Steps(num_elems_processed_per_iteration), border_undefined, border_size());
100 
101  AccessWindowHorizontal input_access(input->info(), -border_size().left, num_elems_read_per_iteration);
102  AccessWindowHorizontal output_x_access(output_x == nullptr ? nullptr : output_x->info(), 0, num_elems_written_per_iteration);
103  AccessWindowHorizontal output_y_access(output_y == nullptr ? nullptr : output_y->info(), 0, num_elems_written_per_iteration);
104 
105  update_window_and_padding(win, input_access, output_x_access, output_y_access);
106 
107  output_x_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
108  output_y_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
109 
110  ICLKernel::configure_internal(win);
111 
112  // Set config_id for enabling LWS tuning
113  _config_id = kernel_name;
114  _config_id += "_";
115  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
116  _config_id += "_";
117  _config_id += support::cpp11::to_string(input->info()->dimension(0));
118  _config_id += "_";
119  _config_id += support::cpp11::to_string(input->info()->dimension(1));
120  _config_id += "_";
121  _config_id += support::cpp11::to_string(border_undefined);
122 }
123 
124 void CLSobel5x5HorKernel::run(const Window &window, cl::CommandQueue &queue)
125 {
128 
130  do
131  {
132  unsigned int idx = 0;
133  add_2D_tensor_argument(idx, _input, slice);
134  add_2D_tensor_argument_if((_run_sobel_x), idx, _output_x, slice);
135  add_2D_tensor_argument_if((_run_sobel_y), idx, _output_y, slice);
136 
137  enqueue(queue, *this, slice, lws_hint());
138  }
139  while(window.slide_window_slice_2D(slice));
140 }
141 
143  : _input_x(nullptr), _input_y(nullptr), _output_x(nullptr), _output_y(nullptr), _run_sobel_x(false), _run_sobel_y(false)
144 {
145 }
146 
148 {
149  return BorderSize{ 2, 0 };
150 }
151 
152 void CLSobel5x5VertKernel::configure(const ICLTensor *input_x, const ICLTensor *input_y, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
153 {
154  configure(CLKernelLibrary::get().get_compile_context(), input_x, input_y, output_x, output_y, border_undefined);
155 }
156 
157 void CLSobel5x5VertKernel::configure(const CLCompileContext &compile_context, const ICLTensor *input_x, const ICLTensor *input_y, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
158 {
159  ARM_COMPUTE_ERROR_ON((output_x == nullptr) && (output_y == nullptr));
160 
161  _run_sobel_x = output_x != nullptr;
162  _run_sobel_y = output_y != nullptr;
163 
164  if(_run_sobel_x)
165  {
168  }
169 
170  if(_run_sobel_y)
171  {
174  }
175 
176  _input_x = input_x;
177  _input_y = input_y;
178  _output_x = output_x;
179  _output_y = output_y;
180 
181  // Set build options
182  std::set<std::string> build_opts;
183 
184  if(_run_sobel_x)
185  {
186  build_opts.insert("-DGRAD_X");
187  }
188 
189  if(_run_sobel_y)
190  {
191  build_opts.insert("-DGRAD_Y");
192  }
193 
194  // Create kernel
195  const std::string kernel_name = std::string("sobel_separable5x1");
196  _kernel = create_kernel(compile_context, kernel_name, build_opts);
197 
198  const ICLTensor *input = _run_sobel_x ? _input_x : _input_y;
199 
200  // Configure kernel window
201  constexpr unsigned int num_elems_processed_per_iteration = 8;
202  constexpr unsigned int num_elems_written_per_iteration = 8;
203  constexpr unsigned int num_elems_read_per_iteration = 8;
204  constexpr unsigned int num_rows_read_per_iteration = 5;
205 
206  Window win = calculate_max_window(*input->info(), Steps(num_elems_processed_per_iteration), border_undefined, border_size());
207 
208  AccessWindowRectangle input_x_access(input_x == nullptr ? nullptr : input_x->info(), 0, -border_size().top, num_elems_read_per_iteration, num_rows_read_per_iteration);
209  AccessWindowRectangle input_y_access(input_y == nullptr ? nullptr : input_y->info(), 0, -border_size().top, num_elems_read_per_iteration, num_rows_read_per_iteration);
210  AccessWindowHorizontal output_x_access(output_x == nullptr ? nullptr : output_x->info(), 0, num_elems_written_per_iteration);
211  AccessWindowHorizontal output_y_access(output_y == nullptr ? nullptr : output_y->info(), 0, num_elems_written_per_iteration);
212 
213  update_window_and_padding(win, input_x_access, input_y_access, output_x_access, output_y_access);
214 
215  output_x_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
216  output_y_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
217 
218  ICLKernel::configure_internal(win);
219 
220  // Set config_id for enabling LWS tuning
221  _config_id = kernel_name;
222  _config_id += "_";
223  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
224  _config_id += "_";
225  _config_id += support::cpp11::to_string(input->info()->dimension(0));
226  _config_id += "_";
227  _config_id += support::cpp11::to_string(input->info()->dimension(1));
228  _config_id += "_";
229  _config_id += support::cpp11::to_string(border_undefined);
230 }
231 
232 void CLSobel5x5VertKernel::run(const Window &window, cl::CommandQueue &queue)
233 {
236 
238  do
239  {
240  unsigned int idx = 0;
241  add_2D_tensor_argument_if((_run_sobel_x), idx, _input_x, slice);
242  add_2D_tensor_argument_if((_run_sobel_x), idx, _output_x, slice);
243  add_2D_tensor_argument_if((_run_sobel_y), idx, _input_y, slice);
244  add_2D_tensor_argument_if((_run_sobel_y), idx, _output_y, slice);
245 
246  _kernel.setArg(idx++, 0 /*dummy*/);
247 
248  enqueue(queue, *this, slice, lws_hint());
249  }
250  while(window.slide_window_slice_2D(slice));
251 }
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:283
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)
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
BorderSize border_size() const override
The size of the border for that kernel.
void add_2D_tensor_argument_if(bool cond, 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:159
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
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
Container for 2D border size.
Definition: Types.h:273
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:276
1 channel, 1 U8 per channel
std::string to_string(T &&value)
Convert integer and float values to string.
CLSobel5x5VertKernel()
Default constructor: initialize all the pointers to nullptr and parameters to zero.
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:466
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:350
Window calculate_max_window_horizontal(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
BorderSize border_size() const override
The size of the border for that kernel.
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:323
Copyright (c) 2017-2021 Arm Limited.
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
void configure(const ICLTensor *input_x, const ICLTensor *input_y, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
Initialise the kernel&#39;s source, destination and border.
Implementation of a rectangular access pattern.
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
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
std::string kernel_name
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
unsigned int left
left of the border
Definition: Types.h:378
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
1 channel, 1 S16 per channel
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
CLCompileContext class.
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
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
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context...
Wrapper to configure the Khronos OpenCL C++ header.
void configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
Initialise the kernel&#39;s source, destination and border.
unsigned int num_elems_processed_per_iteration
CLSobel5x5HorKernel()
Default constructor: initialize all the pointers to nullptr and parameters to zero.
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)