Compute Library
 21.02
CLMagnitudePhaseKernel.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 
34 #include "support/StringSupport.h"
35 
36 #include <set>
37 #include <string>
38 
39 using namespace arm_compute;
40 
42  : _gx(nullptr), _gy(nullptr), _magnitude(nullptr), _phase(nullptr), _run_mag(false), _run_phase(false)
43 {
44 }
45 
47  MagnitudeType mag_type, PhaseType phase_type)
48 {
49  configure(CLKernelLibrary::get().get_compile_context(), gx, gy, magnitude, phase, mag_type, phase_type);
50 }
51 
53  MagnitudeType mag_type, PhaseType phase_type)
54 {
57  ARM_COMPUTE_ERROR_ON((magnitude == nullptr) && (phase == nullptr));
59 
60  _run_mag = (magnitude != nullptr);
61  _run_phase = (phase != nullptr);
62  if(_run_mag)
63  {
66  }
67  if(_run_phase)
68  {
70  }
71 
72  if(!_run_mag && !_run_phase)
73  {
74  ARM_COMPUTE_ERROR("At least one output must be NOT NULL");
75  }
76 
77  _gx = gx;
78  _gy = gy;
79  _magnitude = magnitude;
80  _phase = phase;
81 
82  // Construct kernel name
83  std::set<std::string> build_opts = {};
84 
85  // Add magnitude type
86  if(_run_mag)
87  {
88  switch(mag_type)
89  {
91  build_opts.insert("-DMAGNITUDE=1");
92  break;
94  build_opts.insert("-DMAGNITUDE=2");
95  break;
96  default:
97  ARM_COMPUTE_ERROR("Unsupported magnitude calculation type.");
98  build_opts.insert("-DMAGNITUDE=0");
99  break;
100  }
101  }
102 
103  // Add phase type
104  if(_run_phase)
105  {
106  switch(phase_type)
107  {
108  case PhaseType::UNSIGNED:
109  build_opts.insert("-DPHASE=1");
110  break;
111  case PhaseType::SIGNED:
112  build_opts.insert("-DPHASE=2");
113  break;
114  default:
115  ARM_COMPUTE_ERROR("Unsupported phase calculation type.");
116  build_opts.insert("-DPHASE=0");
117  break;
118  }
119  }
120 
121  // Add data_type
122  build_opts.insert("-DDATA_TYPE=" + get_cl_type_from_data_type(gx->info()->data_type()));
123 
124  // Create kernel
125  const std::string kernel_name = std::string("magnitude_phase");
126  _kernel = create_kernel(compile_context, kernel_name, build_opts);
127 
128  // Configure kernel window
129  constexpr unsigned int num_elems_processed_per_iteration = 16;
130 
131  Window win = calculate_max_window(*gx->info(), Steps(num_elems_processed_per_iteration));
132 
135  AccessWindowHorizontal output_magnitude_access(magnitude == nullptr ? nullptr : magnitude->info(), 0, num_elems_processed_per_iteration);
136  AccessWindowHorizontal output_phase_access(phase == nullptr ? nullptr : phase->info(), 0, num_elems_processed_per_iteration);
137 
139  gx_access, gy_access,
140  output_magnitude_access, output_phase_access);
141 
143  gy->info()->valid_region());
144  output_magnitude_access.set_valid_region(win, valid_region);
145  output_phase_access.set_valid_region(win, valid_region);
146 
147  ICLKernel::configure_internal(win);
148 
149  // Set config_id for enabling LWS tuning
150  _config_id = kernel_name;
151  _config_id += "_";
152  _config_id += lower_string(string_from_data_type(gx->info()->data_type()));
153  _config_id += "_";
154  _config_id += support::cpp11::to_string(gx->info()->dimension(0));
155  _config_id += "_";
156  _config_id += support::cpp11::to_string(gx->info()->dimension(1));
157 }
158 
159 void CLMagnitudePhaseKernel::run(const Window &window, cl::CommandQueue &queue)
160 {
163 
165  do
166  {
167  unsigned int idx = 0;
168  add_2D_tensor_argument(idx, _gx, slice);
169  add_2D_tensor_argument(idx, _gy, slice);
170  add_2D_tensor_argument_if((_run_mag), idx, _magnitude, slice);
171  add_2D_tensor_argument_if((_run_phase), idx, _phase, slice);
172 
173  enqueue(queue, *this, slice, lws_hint());
174  }
175  while(window.slide_window_slice_2D(slice));
176 }
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:283
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
L1 normalization type.
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
Angle range: [0, 180].
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
Angle range: [0, 360].
PhaseType
Phase calculation type.
Definition: Types.h:432
#define ARM_COMPUTE_ERROR(msg)
Print the given message then throw an std::runtime_error.
Definition: Error.h:352
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.
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
SimpleTensor< uint8_t > phase(const SimpleTensor< T > &gx, const SimpleTensor< T > &gy, PhaseType phase_type)
Definition: Phase.cpp:35
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:350
const ValidRegion valid_region
Definition: Scale.cpp:221
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.
1 channel, 1 S32 per channel
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
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:543
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
std::string kernel_name
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
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
ValidRegion intersect_valid_regions(const Ts &... regions)
Intersect multiple valid regions.
Definition: WindowHelpers.h:74
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
1 channel, 1 S16 per channel
L2 normalization type.
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
CLCompileContext class.
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.
unsigned int num_elems_processed_per_iteration
Container for valid region of a window.
Definition: Types.h:188
MagnitudeType
Magnitude calculation type.
Definition: Types.h:422
void configure(const ICLTensor *gx, const ICLTensor *gy, ICLTensor *magnitude, ICLTensor *phase, MagnitudeType mag_type=MagnitudeType::L2NORM, PhaseType phase_type=PhaseType::SIGNED)
Initialise the kernel&#39;s input, output.
Describe a multidimensional execution window.
Definition: Window.h:39
SimpleTensor< T > magnitude(const SimpleTensor< T > &gx, const SimpleTensor< T > &gy, MagnitudeType magnitude_type)
Definition: Magnitude.cpp:35
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)