Compute Library
 20.05
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 
29 #include "arm_compute/core/Error.h"
34 
40 
41 #include <cstddef>
42 
43 using namespace arm_compute;
44 
46  : _input(nullptr), _pyramid(nullptr), _tmp()
47 {
48 }
49 
51  : _horizontal_border_handler(),
52  _vertical_border_handler(),
53  _horizontal_reduction(),
54  _vertical_reduction()
55 {
56 }
57 
58 void CLGaussianPyramidHalf::configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
59 {
60  configure(CLKernelLibrary::get().get_compile_context(), input, pyramid, border_mode, constant_border_value);
61 }
62 
63 void CLGaussianPyramidHalf::configure(const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
64 {
66  ARM_COMPUTE_ERROR_ON(pyramid == nullptr);
67  ARM_COMPUTE_ERROR_ON(input->info()->num_dimensions() != pyramid->get_pyramid_level(0)->info()->num_dimensions());
68  ARM_COMPUTE_ERROR_ON(input->info()->dimension(0) != pyramid->info()->width());
69  ARM_COMPUTE_ERROR_ON(input->info()->dimension(1) != pyramid->info()->height());
71 
72  // Constant value to use for vertical fill border when the border mode is CONSTANT
73  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;
74 
75  /* Get number of pyramid levels */
76  const size_t num_levels = pyramid->info()->num_levels();
77 
78  _input = input;
79  _pyramid = pyramid;
80 
81  if(num_levels > 1)
82  {
83  _horizontal_border_handler.resize(num_levels - 1);
84  _vertical_border_handler.resize(num_levels - 1);
85  _horizontal_reduction.resize(num_levels - 1);
86  _vertical_reduction.resize(num_levels - 1);
87 
88  // Apply half scale to the X dimension of the tensor shape
89  TensorShape tensor_shape = pyramid->info()->tensor_shape();
90  tensor_shape.set(0, (pyramid->info()->width() + 1) * SCALE_PYRAMID_HALF);
91 
92  PyramidInfo pyramid_info(num_levels - 1, SCALE_PYRAMID_HALF, tensor_shape, Format::U16);
93  _tmp.init(pyramid_info);
94 
95  for(size_t i = 0; i < num_levels - 1; ++i)
96  {
97  /* Configure horizontal kernel */
98  _horizontal_reduction[i].configure(compile_context, _pyramid->get_pyramid_level(i), _tmp.get_pyramid_level(i));
99 
100  /* Configure vertical kernel */
101  _vertical_reduction[i].configure(compile_context, _tmp.get_pyramid_level(i), _pyramid->get_pyramid_level(i + 1));
102 
103  /* Configure border */
104  _horizontal_border_handler[i].configure(compile_context, _pyramid->get_pyramid_level(i), _horizontal_reduction[i].border_size(), border_mode, PixelValue(constant_border_value));
105 
106  /* Configure border */
107  _vertical_border_handler[i].configure(compile_context, _tmp.get_pyramid_level(i), _vertical_reduction[i].border_size(), border_mode, PixelValue(pixel_value_u16));
108  }
109  _tmp.allocate();
110  }
111 }
112 
114 {
115  ARM_COMPUTE_ERROR_ON_MSG(_pyramid == nullptr, "Unconfigured function");
116 
117  /* Get number of pyramid levels */
118  const size_t num_levels = _pyramid->info()->num_levels();
119 
120  /* The first level of the pyramid has the input image */
121  _pyramid->get_pyramid_level(0)->map(CLScheduler::get().queue(), true /* blocking */);
122  _input->map(CLScheduler::get().queue(), true /* blocking */);
123  _pyramid->get_pyramid_level(0)->copy_from(*_input);
124 
125  _input->unmap(CLScheduler::get().queue());
126  _pyramid->get_pyramid_level(0)->unmap(CLScheduler::get().queue());
127 
128  for(unsigned int i = 0; i < num_levels - 1; ++i)
129  {
130  CLScheduler::get().enqueue(_horizontal_border_handler[i], false);
131  CLScheduler::get().enqueue(_horizontal_reduction[i], false);
132  CLScheduler::get().enqueue(_vertical_border_handler[i], false);
133  CLScheduler::get().enqueue(_vertical_reduction[i], false);
134  }
135 }
136 
138  : _gauss5x5(),
139  _scale_nearest()
140 {
141 }
142 
143 void CLGaussianPyramidOrb::configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
144 {
145  configure(CLKernelLibrary::get().get_compile_context(), input, pyramid, border_mode, constant_border_value);
146 }
147 
148 void CLGaussianPyramidOrb::configure(const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
149 {
151  ARM_COMPUTE_ERROR_ON(nullptr == pyramid);
152  ARM_COMPUTE_ERROR_ON(input->info()->num_dimensions() != pyramid->get_pyramid_level(0)->info()->num_dimensions());
153  ARM_COMPUTE_ERROR_ON(input->info()->dimension(0) != pyramid->info()->width());
154  ARM_COMPUTE_ERROR_ON(input->info()->dimension(1) != pyramid->info()->height());
156 
157  /* Get number of pyramid levels */
158  const size_t num_levels = pyramid->info()->num_levels();
159 
160  _input = input;
161  _pyramid = pyramid;
162 
163  if(num_levels > 1)
164  {
165  _gauss5x5.resize(num_levels - 1);
166  _scale_nearest.resize(num_levels - 1);
167 
168  PyramidInfo pyramid_info(num_levels - 1, SCALE_PYRAMID_ORB, pyramid->info()->tensor_shape(), Format::U8);
169 
170  _tmp.init(pyramid_info);
171 
172  for(size_t i = 0; i < num_levels - 1; ++i)
173  {
174  /* Configure gaussian 5x5 */
175  _gauss5x5[i].configure(compile_context, _pyramid->get_pyramid_level(i), _tmp.get_pyramid_level(i), border_mode, constant_border_value);
176 
177  /* Configure scale image kernel */
178  _scale_nearest[i].configure(compile_context, _tmp.get_pyramid_level(i), _pyramid->get_pyramid_level(i + 1), InterpolationPolicy::NEAREST_NEIGHBOR, border_mode, SamplingPolicy::CENTER);
179  }
180 
181  _tmp.allocate();
182  }
183 }
184 
186 {
187  ARM_COMPUTE_ERROR_ON_MSG(_pyramid == nullptr, "Unconfigured function");
188 
189  /* Get number of pyramid levels */
190  const size_t num_levels = _pyramid->info()->num_levels();
191 
192  /* The first level of the pyramid has the input image */
193  _pyramid->get_pyramid_level(0)->map(CLScheduler::get().queue(), true /* blocking */);
194  _input->map(CLScheduler::get().queue(), true /* blocking */);
195  _pyramid->get_pyramid_level(0)->copy_from(*_input);
196  _input->unmap(CLScheduler::get().queue());
197  _pyramid->get_pyramid_level(0)->unmap(CLScheduler::get().queue());
198 
199  for(unsigned int i = 0; i < num_levels - 1; ++i)
200  {
201  _gauss5x5[i].run();
202  CLScheduler::get().enqueue(_scale_nearest[i]);
203  }
204 }
BorderMode
Methods available to handle borders.
Definition: Types.h:264
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
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's metadata.
Definition: CLTensor.cpp:41
static CLScheduler & get()
Access the scheduler singleton.
Definition: CLScheduler.cpp:99
1 channel, 1 U8 per channel
const PyramidInfo * info() const override
Interface to be implemented by the child class to return the Pyramid's metadata.
Definition: CLPyramid.cpp:117
void init(size_t num_levels, float scale, size_t width, size_t height, Format format)
Initialize pyramid'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-2020 ARM Limited.
Samples are taken at pixel center.
void configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override
Initialise the function's source, destinations and border mode.
size_t num_dimensions() const override
The number of dimensions of the tensor (rank)
Definition: TensorInfo.h:253
Basic implementation of the OpenCL pyramid interface.
Definition: CLPyramid.h:40
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
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.
CLCompileContext class.
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
Store the Pyramid's metadata.
Definition: PyramidInfo.h:35
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
TensorShape & set(size_t dimension, size_t value, bool apply_dim_correction=true)
Accessor to set the value of one of the dimensions.
Definition: TensorShape.h:78
size_t width() const
Return the width of the 0th level tensor.
Definition: PyramidInfo.cpp:82
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
void configure(ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override
Initialise the function's source, destinations and border mode.