Compute Library
 21.02
CLGaussianPyramidOrb Class Reference

Basic function to execute gaussian pyramid with ORB scale factor. More...

#include <CLGaussianPyramid.h>

Collaboration diagram for CLGaussianPyramidOrb:
[legend]

Public Member Functions

 CLGaussianPyramidOrb ()
 Constructor. More...
 
void configure (ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override
 Initialise the function's source, destinations and border mode. More...
 
void configure (const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value) override
 Initialise the function's source, destinations and border mode. More...
 
void run () override
 Run the kernels contained in the function. More...
 
- Public Member Functions inherited from CLGaussianPyramid
 CLGaussianPyramid ()
 Constructor. More...
 
 CLGaussianPyramid (const CLGaussianPyramid &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLGaussianPyramidoperator= (const CLGaussianPyramid &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLGaussianPyramid (CLGaussianPyramid &&)=default
 Allow instances of this class to be moved. More...
 
CLGaussianPyramidoperator= (CLGaussianPyramid &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLGaussianPyramid ()
 Default destructor. More...
 
- Public Member Functions inherited from IFunction
virtual ~IFunction ()=default
 Destructor. More...
 
virtual void prepare ()
 Prepare the function for executing. More...
 

Detailed Description

Basic function to execute gaussian pyramid with ORB scale factor.

This function calls the following OpenCL kernels and functions:

  1. CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
  2. CLGaussian5x5
  3. CLScaleKernel

Definition at line 127 of file CLGaussianPyramid.h.

Constructor & Destructor Documentation

◆ CLGaussianPyramidOrb()

Constructor.

Definition at line 146 of file CLGaussianPyramid.cpp.

147  : _gauss5x5(),
148  _scale_nearest()
149 {
150 }

Member Function Documentation

◆ configure() [1/2]

void configure ( ICLTensor input,
CLPyramid pyramid,
BorderMode  border_mode,
uint8_t  constant_border_value 
)
overridevirtual

Initialise the function's source, destinations and border mode.

Parameters
[in,out]inputSource tensor. Data types supported: U8. (Written to only for border_mode != UNDEFINED)
[out]pyramidDestination pyramid tensors, Data types supported at each level: U8.
[in]border_modeBorder mode to use.
[in]constant_border_value(Optional) Constant value to use for borders if border_mode is set to CONSTANT.

Implements CLGaussianPyramid.

Definition at line 152 of file CLGaussianPyramid.cpp.

References CLKernelLibrary::get().

153 {
154  configure(CLKernelLibrary::get().get_compile_context(), input, pyramid, border_mode, constant_border_value);
155 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
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.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
ICLTensor input,
CLPyramid pyramid,
BorderMode  border_mode,
uint8_t  constant_border_value 
)
overridevirtual

Initialise the function's source, destinations and border mode.

Parameters
[in]compile_contextThe compile context to be used.
[in,out]inputSource tensor. Data types supported: U8. (Written to only for border_mode != UNDEFINED)
[out]pyramidDestination pyramid tensors, Data types supported at each level: U8.
[in]border_modeBorder mode to use.
[in]constant_border_value(Optional) Constant value to use for borders if border_mode is set to CONSTANT.

Implements CLGaussianPyramid.

Definition at line 157 of file CLGaussianPyramid.cpp.

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, arm_compute::CENTER, ITensorInfo::dimension(), CLPyramid::get_pyramid_level(), PyramidInfo::height(), ITensor::info(), CLPyramid::info(), CLTensor::info(), PyramidInfo::init(), arm_compute::test::validation::input, arm_compute::NEAREST_NEIGHBOR, ITensorInfo::num_dimensions(), TensorInfo::num_dimensions(), PyramidInfo::num_levels(), PyramidInfo::scale(), arm_compute::SCALE_PYRAMID_ORB, PyramidInfo::tensor_shape(), arm_compute::U8, and PyramidInfo::width().

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 }
constexpr float SCALE_PYRAMID_ORB
Constant value used to indicate a ORB scaled pyramid.
Definition: Types.h:115
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
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.
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
Output values are defined to match the source pixel whose center is nearest to the sample position...
Samples are taken at pixel center.
size_t num_dimensions() const override
The number of dimensions of the tensor (rank)
Definition: TensorInfo.h:254
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.
#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
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
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

◆ run()

void run ( )
overridevirtual

Run the kernels contained in the function.

For Neon kernels:

  • Multi-threading is used for the kernels which are parallelisable.
  • By default std::thread::hardware_concurrency() threads are used.
Note
CPPScheduler::set_num_threads() can be used to manually set the number of threads

For OpenCL kernels:

  • All the kernels are enqueued on the queue associated with CLScheduler.
  • The queue is then flushed.
Note
The function will not block until the kernels are executed. It is the user's responsibility to wait.
Will call prepare() on first run if hasn't been done

Implements IFunction.

Definition at line 195 of file CLGaussianPyramid.cpp.

References ARM_COMPUTE_ERROR_ON_MSG, CLScheduler::enqueue(), and CLScheduler::get().

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 }
static CLScheduler & get()
Access the scheduler singleton.
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
void enqueue(ICLKernel &kernel, bool flush=true)
Schedule the execution of the passed kernel if possible.

The documentation for this class was generated from the following files: