Compute Library
CLGaussianPyramidHalf Class Reference

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

#include <CLGaussianPyramid.h>

Collaboration diagram for CLGaussianPyramidHalf:

Public Member Functions

 CLGaussianPyramidHalf ()
 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 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...
virtual ~CLGaussianPyramid ()=default
 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 HALF scale factor.

This function calls the following OpenCL kernels:

  1. CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
  2. CLGaussianPyramidHorKernel
  3. CLGaussianPyramidVertKernel

Definition at line 81 of file CLGaussianPyramid.h.

Constructor & Destructor Documentation

◆ CLGaussianPyramidHalf()


Definition at line 51 of file CLGaussianPyramid.cpp.

52  : _horizontal_border_handler(),
53  _vertical_border_handler(),
54  _horizontal_reduction(),
55  _vertical_reduction()
56 {
57 }

Member Function Documentation

◆ configure()

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

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

[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 59 of file CLGaussianPyramid.cpp.

60 {
62  ARM_COMPUTE_ERROR_ON(pyramid == nullptr);
63  ARM_COMPUTE_ERROR_ON(input->info()->num_dimensions() != pyramid->get_pyramid_level(0)->info()->num_dimensions());
64  ARM_COMPUTE_ERROR_ON(input->info()->dimension(0) != pyramid->info()->width());
65  ARM_COMPUTE_ERROR_ON(input->info()->dimension(1) != pyramid->info()->height());
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;
71  /* Get number of pyramid levels */
72  const size_t num_levels = pyramid->info()->num_levels();
74  _input = input;
75  _pyramid = pyramid;
77  if(num_levels > 1)
78  {
79  _horizontal_border_handler.resize(num_levels - 1);
80  _vertical_border_handler.resize(num_levels - 1);
81  _horizontal_reduction.resize(num_levels - 1);
82  _vertical_reduction.resize(num_levels - 1);
84  // Apply half scale to the X dimension of the tensor shape
85  TensorShape tensor_shape = pyramid->info()->tensor_shape();
86  tensor_shape.set(0, (pyramid->info()->width() + 1) * SCALE_PYRAMID_HALF);
88  PyramidInfo pyramid_info(num_levels - 1, SCALE_PYRAMID_HALF, tensor_shape, Format::U16);
89  _tmp.init(pyramid_info);
91  for(size_t i = 0; i < num_levels - 1; ++i)
92  {
93  /* Configure horizontal kernel */
94  _horizontal_reduction[i].configure(_pyramid->get_pyramid_level(i), _tmp.get_pyramid_level(i));
96  /* Configure vertical kernel */
97  _vertical_reduction[i].configure(_tmp.get_pyramid_level(i), _pyramid->get_pyramid_level(i + 1));
99  /* Configure border */
100  _horizontal_border_handler[i].configure(_pyramid->get_pyramid_level(i), _horizontal_reduction[i].border_size(), border_mode, PixelValue(constant_border_value));
102  /* Configure border */
103  _vertical_border_handler[i].configure(_tmp.get_pyramid_level(i), _vertical_reduction[i].border_size(), border_mode, PixelValue(pixel_value_u16));
104  }
105  _tmp.allocate();
106  }
107 }
constexpr float SCALE_PYRAMID_HALF
Constant value used to indicate a half-scale pyramid.
Definition: Types.h:108
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
TensorInfo * info() const override
Interface to be implemented by the child class to return the tensor's metadata.
Definition: CLTensor.cpp:41
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:118
#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
1 channel, 1 U16 per channel
size_t num_dimensions() const override
The number of dimensions of the tensor (rank)
Definition: TensorInfo.h:253
float scale() const
Return the scale factor of the pyramid.
Definition: Validate.h:790
Store the Pyramid'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:123
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

References ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN, arm_compute::test::validation::border_mode, CLPyramid::get_pyramid_level(), PyramidInfo::height(), CLPyramid::info(), CLTensor::info(), arm_compute::test::validation::input, TensorInfo::num_dimensions(), PyramidInfo::num_levels(), PyramidInfo::scale(), arm_compute::SCALE_PYRAMID_HALF, TensorShape::set(), PyramidInfo::tensor_shape(), arm_compute::U16, arm_compute::U8, and PyramidInfo::width().

Referenced by CLLaplacianPyramid::configure().

◆ run()

void run ( )

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.
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.
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 109 of file CLGaussianPyramid.cpp.

110 {
111  ARM_COMPUTE_ERROR_ON_MSG(_pyramid == nullptr, "Unconfigured function");
113  /* Get number of pyramid levels */
114  const size_t num_levels = _pyramid->info()->num_levels();
116  /* The first level of the pyramid has the input image */
117  _pyramid->get_pyramid_level(0)->map(CLScheduler::get().queue(), true /* blocking */);
118  _input->map(CLScheduler::get().queue(), true /* blocking */);
119  _pyramid->get_pyramid_level(0)->copy_from(*_input);
121  _input->unmap(CLScheduler::get().queue());
122  _pyramid->get_pyramid_level(0)->unmap(CLScheduler::get().queue());
124  for(unsigned int i = 0; i < num_levels - 1; ++i)
125  {
126  CLScheduler::get().enqueue(_horizontal_border_handler[i], false);
127  CLScheduler::get().enqueue(_horizontal_reduction[i], false);
128  CLScheduler::get().enqueue(_vertical_border_handler[i], false);
129  CLScheduler::get().enqueue(_vertical_reduction[i], false);
130  }
131 }
static CLScheduler & get()
Access the scheduler singleton.
Definition: CLScheduler.cpp:99
#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.

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

Referenced by CLLaplacianPyramid::run().

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