Compute Library
 21.02
NEGaussianPyramid.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 
26 #include "arm_compute/core/Error.h"
39 
40 #include <cstddef>
41 
42 using namespace arm_compute;
43 
45  : _input(nullptr), _pyramid(nullptr), _tmp()
46 {
47 }
48 
50 
52  : _horizontal_border_handler(),
53  _vertical_border_handler(),
54  _horizontal_reduction(),
55  _vertical_reduction()
56 {
57 }
58 
59 void NEGaussianPyramidHalf::configure(const ITensor *input, IPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
60 {
62  ARM_COMPUTE_ERROR_ON(nullptr == pyramid);
64  ARM_COMPUTE_ERROR_ON(input->info()->dimension(0) != pyramid->info()->width());
65  ARM_COMPUTE_ERROR_ON(input->info()->dimension(1) != pyramid->info()->height());
67 
68  // Constant value to use for vertical fill border when the border mode is CONSTANT
69  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;
70 
71  /* Get number of pyramid levels */
72  const size_t num_levels = pyramid->info()->num_levels();
73  const size_t num_stages = num_levels - 1;
74 
75  _input = input;
76  _pyramid = pyramid;
77 
78  if(num_levels > 1)
79  {
80  // Apply half scale to the X dimension of the tensor shape
81  TensorShape tensor_shape = pyramid->info()->tensor_shape();
82  tensor_shape.set(0, (pyramid->info()->width() + 1) * SCALE_PYRAMID_HALF);
83 
84  PyramidInfo pyramid_info(num_levels - 1, SCALE_PYRAMID_HALF, tensor_shape, Format::S16);
85  _tmp.init(pyramid_info);
86 
87  _horizontal_reduction.clear();
88  _vertical_reduction.clear();
89  _horizontal_border_handler.clear();
90  _vertical_border_handler.clear();
91 
92  _horizontal_reduction.resize(num_stages);
93  _vertical_reduction.resize(num_stages);
94  _horizontal_border_handler.resize(num_stages);
95  _vertical_border_handler.resize(num_stages);
96 
97  for(size_t i = 0; i < num_stages; ++i)
98  {
99  /* Configure horizontal kernel */
100  _horizontal_reduction[i] = std::make_unique<NEGaussianPyramidHorKernel>();
101  _horizontal_reduction[i]->configure(_pyramid->get_pyramid_level(i), _tmp.get_pyramid_level(i));
102 
103  /* Configure vertical kernel */
104  _vertical_reduction[i] = std::make_unique<NEGaussianPyramidVertKernel>();
105  _vertical_reduction[i]->configure(_tmp.get_pyramid_level(i), _pyramid->get_pyramid_level(i + 1));
106 
107  /* Configure border */
108  _horizontal_border_handler[i] = std::make_unique<NEFillBorderKernel>();
109  _horizontal_border_handler[i]->configure(_pyramid->get_pyramid_level(i), _horizontal_reduction[i]->border_size(), border_mode, PixelValue(constant_border_value));
110 
111  /* Configure border */
112  _vertical_border_handler[i] = std::make_unique<NEFillBorderKernel>();
113  _vertical_border_handler[i]->configure(_tmp.get_pyramid_level(i), _vertical_reduction[i]->border_size(), border_mode, PixelValue(pixel_value_u16));
114  }
115 
116  _tmp.allocate();
117  }
118 }
119 
121 {
122  ARM_COMPUTE_ERROR_ON_MSG(_pyramid == nullptr, "Unconfigured function");
123 
124  /* Get number of pyramid levels */
125  const unsigned int num_levels = _pyramid->info()->num_levels();
126 
127  /* The first level of the pyramid has the input image */
128  _pyramid->get_pyramid_level(0)->copy_from(*_input);
129 
130  for(unsigned int i = 0; i < num_levels - 1; ++i)
131  {
132  NEScheduler::get().schedule(_horizontal_border_handler[i].get(), Window::DimZ);
133  NEScheduler::get().schedule(_horizontal_reduction[i].get(), Window::DimY);
134  NEScheduler::get().schedule(_vertical_border_handler[i].get(), Window::DimZ);
135  NEScheduler::get().schedule(_vertical_reduction[i].get(), Window::DimY);
136  }
137 }
138 
140 
142  : _gaus5x5(),
143  _scale_nearest()
144 {
145 }
146 
147 void NEGaussianPyramidOrb::configure(const ITensor *input, IPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value)
148 {
150  ARM_COMPUTE_ERROR_ON(nullptr == pyramid);
152  ARM_COMPUTE_ERROR_ON(input->info()->dimension(0) != pyramid->info()->width());
153  ARM_COMPUTE_ERROR_ON(input->info()->dimension(1) != pyramid->info()->height());
155 
156  /* Get number of pyramid levels */
157  const size_t num_levels = pyramid->info()->num_levels();
158  const size_t num_stages = num_levels - 1;
159 
160  _input = input;
161  _pyramid = pyramid;
162 
163  _gaus5x5.clear();
164  _scale_nearest.clear();
165 
166  _gaus5x5.resize(num_stages);
167  _scale_nearest.resize(num_stages);
168 
169  if(num_levels > 1)
170  {
171  PyramidInfo pyramid_info(num_levels - 1, SCALE_PYRAMID_ORB, pyramid->info()->tensor_shape(), Format::U8);
172  _tmp.init(pyramid_info);
173 
174  for(size_t i = 0; i < num_levels - 1; ++i)
175  {
176  /* Configure gaussian 5x5 */
177  _gaus5x5[i].configure(_pyramid->get_pyramid_level(i), _tmp.get_pyramid_level(i), border_mode, constant_border_value);
178 
179  /* Configure scale */
180  _scale_nearest[i].configure(_tmp.get_pyramid_level(i), _pyramid->get_pyramid_level(i + 1), ScaleKernelInfo{ InterpolationPolicy::NEAREST_NEIGHBOR, BorderMode::UNDEFINED, PixelValue(), SamplingPolicy::CENTER, false });
181  }
182 
183  _tmp.allocate();
184  }
185 }
186 
188 {
189  ARM_COMPUTE_ERROR_ON_MSG(_pyramid == nullptr, "Unconfigured function");
190 
191  /* Get number of pyramid levels */
192  const size_t num_levels = _pyramid->info()->num_levels();
193 
194  /* The first level of the pyramid has the input image */
195  _pyramid->get_pyramid_level(0)->copy_from(*_input);
196 
197  for(unsigned int i = 0; i < num_levels - 1; ++i)
198  {
199  _gaus5x5[i].run();
200  _scale_nearest[i].run();
201  }
202 }
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
void run() override
Run the kernels contained in the function.
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
virtual const PyramidInfo * info() const =0
Interface to be implemented by the child class to return the Pyramid&#39;s metadata.
~NEGaussianPyramidOrb()
Default destructor.
void configure(const ITensor *input, IPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override
Initialise the function&#39;s source, destinations and border mode.
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
1 channel, 1 U8 per channel
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
Output values are defined to match the source pixel whose center is nearest to the sample position...
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
Samples are taken at pixel center.
Interface for pyramid data-object.
Definition: IPyramid.h:36
virtual ITensor * get_pyramid_level(size_t index) const =0
Retrieves a level of the pyramid as a ITensor pointer.
~NEGaussianPyramidHalf()
Default destructor.
void run() override
Run the kernels contained in the function.
#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 configure(const ITensor *input, IPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override
Initialise the function&#39;s source, destinations and border mode.
1 channel, 1 S16 per channel
NEGaussianPyramid()
Default constructor.
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
Store the Pyramid&#39;s metadata.
Definition: PyramidInfo.h:35
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
virtual void schedule(ICPPKernel *kernel, const Hints &hints)=0
Runs the kernel in the same thread as the caller synchronously.
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
Borders are left undefined.
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
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
static IScheduler & get()
Access the scheduler singleton.
Definition: Scheduler.cpp:94