Compute Library
 21.02
CLGaussianPyramid.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 
27 #include "arm_compute/core/Error.h"
41 
42 #include <cstddef>
43 
44 using namespace arm_compute;
45 
47  : _input(nullptr), _pyramid(nullptr), _tmp()
48 {
49 }
50 
52 
54  : _horizontal_border_handler(),
55  _vertical_border_handler(),
56  _horizontal_reduction(),
57  _vertical_reduction()
58 {
59 }
60 
62 
63 void CLGaussianPyramidHalf::configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
64 {
65  configure(CLKernelLibrary::get().get_compile_context(), input, pyramid, border_mode, constant_border_value);
66 }
67 
68 void CLGaussianPyramidHalf::configure(const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
69 {
71  ARM_COMPUTE_ERROR_ON(pyramid == nullptr);
73  ARM_COMPUTE_ERROR_ON(input->info()->dimension(0) != pyramid->info()->width());
74  ARM_COMPUTE_ERROR_ON(input->info()->dimension(1) != pyramid->info()->height());
76 
77  // Constant value to use for vertical fill border when the border mode is CONSTANT
78  const uint16_t pixel_value_u16 = static_cast<uint16_t>(constant_border_value) * 2 + static_cast<uint16_t>(constant_border_value) * 8 + static_cast<uint16_t>(constant_border_value) * 6;
79 
80  /* Get number of pyramid levels */
81  const size_t num_levels = pyramid->info()->num_levels();
82 
83  _input = input;
84  _pyramid = pyramid;
85 
86  if(num_levels > 1)
87  {
88  _horizontal_border_handler.reserve(num_levels - 1);
89  _vertical_border_handler.reserve(num_levels - 1);
90  _horizontal_reduction.reserve(num_levels - 1);
91  _vertical_reduction.reserve(num_levels - 1);
92 
93  // Apply half scale to the X dimension of the tensor shape
94  TensorShape tensor_shape = pyramid->info()->tensor_shape();
95  tensor_shape.set(0, (pyramid->info()->width() + 1) * SCALE_PYRAMID_HALF);
96 
97  PyramidInfo pyramid_info(num_levels - 1, SCALE_PYRAMID_HALF, tensor_shape, Format::U16);
98  _tmp.init(pyramid_info);
99 
100  for(size_t i = 0; i < num_levels - 1; ++i)
101  {
102  /* Configure horizontal kernel */
103  _horizontal_reduction.emplace_back(std::make_unique<CLGaussianPyramidHorKernel>());
104  _horizontal_reduction.back()->configure(compile_context, _pyramid->get_pyramid_level(i), _tmp.get_pyramid_level(i));
105 
106  /* Configure vertical kernel */
107  _vertical_reduction.emplace_back(std::make_unique<CLGaussianPyramidVertKernel>());
108  _vertical_reduction.back()->configure(compile_context, _tmp.get_pyramid_level(i), _pyramid->get_pyramid_level(i + 1));
109 
110  /* Configure border */
111  _horizontal_border_handler.emplace_back(std::make_unique<CLFillBorderKernel>());
112  _horizontal_border_handler.back()->configure(compile_context, _pyramid->get_pyramid_level(i), _horizontal_reduction.back()->border_size(), border_mode, PixelValue(constant_border_value));
113 
114  /* Configure border */
115  _vertical_border_handler.emplace_back(std::make_unique<CLFillBorderKernel>());
116  _vertical_border_handler.back()->configure(compile_context, _tmp.get_pyramid_level(i), _vertical_reduction.back()->border_size(), border_mode, PixelValue(pixel_value_u16));
117  }
118  _tmp.allocate();
119  }
120 }
121 
123 {
124  ARM_COMPUTE_ERROR_ON_MSG(_pyramid == nullptr, "Unconfigured function");
125 
126  /* Get number of pyramid levels */
127  const size_t num_levels = _pyramid->info()->num_levels();
128 
129  /* The first level of the pyramid has the input image */
130  _pyramid->get_pyramid_level(0)->map(CLScheduler::get().queue(), true /* blocking */);
131  _input->map(CLScheduler::get().queue(), true /* blocking */);
132  _pyramid->get_pyramid_level(0)->copy_from(*_input);
133 
134  _input->unmap(CLScheduler::get().queue());
135  _pyramid->get_pyramid_level(0)->unmap(CLScheduler::get().queue());
136 
137  for(unsigned int i = 0; i < num_levels - 1; ++i)
138  {
139  CLScheduler::get().enqueue(*_horizontal_border_handler[i], false);
140  CLScheduler::get().enqueue(*_horizontal_reduction[i], false);
141  CLScheduler::get().enqueue(*_vertical_border_handler[i], false);
142  CLScheduler::get().enqueue(*_vertical_reduction[i], false);
143  }
144 }
145 
147  : _gauss5x5(),
148  _scale_nearest()
149 {
150 }
151 
152 void CLGaussianPyramidOrb::configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
153 {
154  configure(CLKernelLibrary::get().get_compile_context(), input, pyramid, border_mode, constant_border_value);
155 }
156 
157 void CLGaussianPyramidOrb::configure(const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
158 {
160  ARM_COMPUTE_ERROR_ON(nullptr == pyramid);
162  ARM_COMPUTE_ERROR_ON(input->info()->dimension(0) != pyramid->info()->width());
163  ARM_COMPUTE_ERROR_ON(input->info()->dimension(1) != pyramid->info()->height());
165 
166  /* Get number of pyramid levels */
167  const size_t num_levels = pyramid->info()->num_levels();
168 
169  _input = input;
170  _pyramid = pyramid;
171 
172  if(num_levels > 1)
173  {
174  _gauss5x5.resize(num_levels - 1);
175  _scale_nearest.reserve(num_levels - 1);
176 
177  PyramidInfo pyramid_info(num_levels - 1, SCALE_PYRAMID_ORB, pyramid->info()->tensor_shape(), Format::U8);
178 
179  _tmp.init(pyramid_info);
180 
181  for(size_t i = 0; i < num_levels - 1; ++i)
182  {
183  /* Configure gaussian 5x5 */
184  _gauss5x5[i].configure(compile_context, _pyramid->get_pyramid_level(i), _tmp.get_pyramid_level(i), border_mode, constant_border_value);
185 
186  /* Configure scale image kernel */
187  _scale_nearest.emplace_back(std::make_unique<CLScaleKernel>());
188  _scale_nearest.back()->configure(compile_context, _tmp.get_pyramid_level(i), _pyramid->get_pyramid_level(i + 1), ScaleKernelInfo{ InterpolationPolicy::NEAREST_NEIGHBOR, border_mode, PixelValue(), SamplingPolicy::CENTER });
189  }
190 
191  _tmp.allocate();
192  }
193 }
194 
196 {
197  ARM_COMPUTE_ERROR_ON_MSG(_pyramid == nullptr, "Unconfigured function");
198 
199  /* Get number of pyramid levels */
200  const size_t num_levels = _pyramid->info()->num_levels();
201 
202  /* The first level of the pyramid has the input image */
203  _pyramid->get_pyramid_level(0)->map(CLScheduler::get().queue(), true /* blocking */);
204  _input->map(CLScheduler::get().queue(), true /* blocking */);
205  _pyramid->get_pyramid_level(0)->copy_from(*_input);
206  _input->unmap(CLScheduler::get().queue());
207  _pyramid->get_pyramid_level(0)->unmap(CLScheduler::get().queue());
208 
209  for(unsigned int i = 0; i < num_levels - 1; ++i)
210  {
211  _gauss5x5[i].run();
212  CLScheduler::get().enqueue(*_scale_nearest[i]);
213  }
214 }
BorderMode
Methods available to handle borders.
Definition: Types.h:265
constexpr float SCALE_PYRAMID_ORB
Constant value used to indicate a ORB scaled pyramid.
Definition: Types.h:115
constexpr float SCALE_PYRAMID_HALF
Constant value used to indicate a half-scale pyramid.
Definition: Types.h:112
virtual size_t num_dimensions() const =0
The number of dimensions of the tensor (rank)
const TensorShape & tensor_shape() const
Return the TensorShape of the o-th level tensor.
Definition: PyramidInfo.cpp:92
Class describing the value of a pixel for any image format.
Definition: PixelValue.h:34
Shape of a tensor.
Definition: TensorShape.h:39
void run() override
Run the kernels contained in the function.
TensorInfo * info() const override
Interface to be implemented by the child class to return the tensor&#39;s metadata.
Definition: CLTensor.cpp:41
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
static CLScheduler & get()
Access the scheduler singleton.
1 channel, 1 U8 per channel
const PyramidInfo * info() const override
Interface to be implemented by the child class to return the Pyramid&#39;s metadata.
Definition: CLPyramid.cpp:117
void init(size_t num_levels, float scale, size_t width, size_t height, Format format)
Initialize pyramid&#39;s metadata for 2D tensors.
Definition: PyramidInfo.cpp:50
#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.
1 channel, 1 U16 per channel
Output values are defined to match the source pixel whose center is nearest to the sample position...
Copyright (c) 2017-2021 Arm Limited.
Samples are taken at pixel center.
Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
void configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override
Initialise the function&#39;s source, destinations and border mode.
size_t num_dimensions() const override
The number of dimensions of the tensor (rank)
Definition: TensorInfo.h:254
Basic implementation of the OpenCL pyramid interface.
Definition: CLPyramid.h:40
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
float scale() const
Return the scale factor of the pyramid.
void enqueue(ICLKernel &kernel, bool flush=true)
Schedule the execution of the passed kernel if possible.
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
CLCompileContext class.
Store the Pyramid&#39;s metadata.
Definition: PyramidInfo.h:35
~CLGaussianPyramidHalf()
Default destructor.
void run() override
Run the kernels contained in the function.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
CLTensor * get_pyramid_level(size_t index) const override
Retrieves a level of the pyramid as a ITensor pointer.
Definition: CLPyramid.cpp:122
size_t width() const
Return the width of the 0th level tensor.
Definition: PyramidInfo.cpp:82
~CLGaussianPyramid()
Default destructor.
size_t num_levels() const
Return the number of the pyramid levels.
Definition: PyramidInfo.cpp:77
size_t height() const
Return the height of the 0th level tensor.
Definition: PyramidInfo.cpp:87
TensorShape & set(size_t dimension, size_t value, bool apply_dim_correction=true, bool increase_dim_unit=true)
Accessor to set the value of one of the dimensions.
Definition: TensorShape.h:79
void configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override
Initialise the function&#39;s source, destinations and border mode.