Compute Library
 21.02
CLNonLinearFilterKernel.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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 "arm_compute/core/Utils.h"
35 
36 #include <algorithm>
37 #include <cmath>
38 #include <cstdlib>
39 #include <set>
40 #include <sstream>
41 #include <string>
42 
43 using namespace arm_compute;
44 
46  : _border_size(0)
47 {
48 }
49 
51 {
52  return _border_size;
53 }
54 
56  unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask,
57  bool border_undefined)
58 {
59  configure(CLKernelLibrary::get().get_compile_context(), input, output, function, mask_size, pattern, mask, border_undefined);
60 }
61 
63  unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask,
64  bool border_undefined)
65 {
68  ARM_COMPUTE_ERROR_ON(mask_size != 3 && mask_size != 5);
69  ARM_COMPUTE_ERROR_ON_MSG(pattern == MatrixPattern::OTHER, "MatrixPattern::OTHER is not supported!");
70  ARM_COMPUTE_UNUSED(mask);
71 
72  _input = input;
73  _output = output;
74  _border_size = BorderSize(mask_size / 2);
75 
76  // Define build options
77  std::set<std::string> build_opts;
78  build_opts.emplace("-D" + string_from_non_linear_filter_function(function));
79 
80  // Define kernel
81  std::string pattern_name = string_from_matrix_pattern(pattern);
82  std::transform(pattern_name.begin(), pattern_name.end(), pattern_name.begin(), ::tolower);
83  std::stringstream ss;
84  ss << "non_linear_filter_" << pattern_name << mask_size << "x" << mask_size;
85 
86  // Create kernel
87  _kernel = create_kernel(compile_context, ss.str(), build_opts);
88 
89  // Configure kernel window
90  constexpr unsigned int num_elems_processed_per_iteration = 8;
91  constexpr unsigned int num_elems_read_per_iteration = 16;
92  const unsigned int num_rows_read_per_iteration = mask_size;
93 
94  Window win = calculate_max_window(*input->info(), num_elems_processed_per_iteration, border_undefined, border_size());
95 
96  AccessWindowRectangle input_access(input->info(), -border_size().left, -border_size().top, num_elems_read_per_iteration, num_rows_read_per_iteration);
98 
99  update_window_and_padding(win, input_access, output_access);
100 
101  output_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
102 
103  ICLKernel::configure_internal(win);
104 }
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)
const std::string & string_from_matrix_pattern(MatrixPattern pattern)
Convert a matrix pattern into a string.
Definition: Utils.cpp:187
Container for 2D border size.
Definition: Types.h:273
void configure(const ICLTensor *input, ICLTensor *output, NonLinearFilterFunction function, unsigned int mask_size, MatrixPattern pattern, const uint8_t *mask, bool border_undefined)
Set the source, destination and border mode of the kernel.
1 channel, 1 U8 per channel
BorderSize border_size() const override
The size of the border for that kernel.
std::stringstream ss(mlgo_str)
#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.
Copyright (c) 2017-2021 Arm Limited.
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
std::string tolower(std::string string)
Convert string to lower case.
Definition: Utility.h:203
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
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
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
Implementation of a row access pattern.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
const std::string & string_from_non_linear_filter_function(NonLinearFilterFunction function)
Translates a given non linear function to a string.
Definition: Utils.cpp:200
unsigned int left
left of the border
Definition: Types.h:378
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
CLCompileContext class.
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.
unsigned int num_elems_processed_per_iteration
MatrixPattern
Available matrix patterns.
Definition: Types.h:504
Any other matrix pattern.
Describe a multidimensional execution window.
Definition: Window.h:39
NonLinearFilterFunction
Available non linear functions.
Definition: Types.h:513