Compute Library
 21.02
CLGaussianPyramid Class Referenceabstract

Common interface for all Gaussian pyramid functions. More...

#include <CLGaussianPyramid.h>

Collaboration diagram for CLGaussianPyramid:
[legend]

Public Member Functions

 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...
 
virtual void configure (ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value=0)=0
 Initialise the function's source, destinations and border mode. More...
 
virtual void configure (const CLCompileContext &compile_context, ICLTensor *input, CLPyramid *pyramid, BorderMode border_mode, uint8_t constant_border_value=0)=0
 Initialise the function's source, destinations and border mode. More...
 
- Public Member Functions inherited from IFunction
virtual ~IFunction ()=default
 Destructor. More...
 
virtual void run ()=0
 Run the kernels contained in the function. More...
 
virtual void prepare ()
 Prepare the function for executing. More...
 

Detailed Description

Common interface for all Gaussian pyramid functions.

Deprecated:
This function is deprecated and is intended to be removed in 21.05 release

Definition at line 50 of file CLGaussianPyramid.h.

Constructor & Destructor Documentation

◆ CLGaussianPyramid() [1/3]

Constructor.

Definition at line 46 of file CLGaussianPyramid.cpp.

References CLGaussianPyramid::~CLGaussianPyramid().

47  : _input(nullptr), _pyramid(nullptr), _tmp()
48 {
49 }

◆ CLGaussianPyramid() [2/3]

CLGaussianPyramid ( const CLGaussianPyramid )
delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ CLGaussianPyramid() [3/3]

Allow instances of this class to be moved.

◆ ~CLGaussianPyramid()

~CLGaussianPyramid ( )
default

Default destructor.

Referenced by CLGaussianPyramid::CLGaussianPyramid().

Member Function Documentation

◆ configure() [1/2]

virtual void configure ( ICLTensor input,
CLPyramid pyramid,
BorderMode  border_mode,
uint8_t  constant_border_value = 0 
)
pure virtual

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.

Implemented in CLGaussianPyramidOrb, and CLGaussianPyramidHalf.

◆ configure() [2/2]

virtual void configure ( const CLCompileContext compile_context,
ICLTensor input,
CLPyramid pyramid,
BorderMode  border_mode,
uint8_t  constant_border_value = 0 
)
pure virtual

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.

Implemented in CLGaussianPyramidOrb, and CLGaussianPyramidHalf.

◆ operator=() [1/2]

CLGaussianPyramid& operator= ( const CLGaussianPyramid )
delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ operator=() [2/2]

CLGaussianPyramid& operator= ( CLGaussianPyramid &&  )
default

Allow instances of this class to be moved.


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