The blo Library
Loading...
Searching...
No Matches
Public Member Functions | Related Functions | List of all members
blo::ImageGaussianPyramid< T, C > Class Template Reference

Gaussian image pyramid processor. More...

#include <ImageGaussianPyramid.h>

Public Member Functions

 ImageGaussianPyramid ()
 Default constructor.
 
 ImageGaussianPyramid (int roiWidth, int roiHeight, int levels)
 Constructs Gaussian image pyramid processor of specified size work buffers.
 
 ImageGaussianPyramid (const ImageGaussianPyramid &rhs)
 Copy constructor.
 
 ImageGaussianPyramid (ImageGaussianPyramid &&rhs) noexcept
 Move constructor.
 
virtual ~ImageGaussianPyramid ()
 Destructor.
 
ImageGaussianPyramid & operator= (const ImageGaussianPyramid &rhs)
 Copy assignment operator.
 
ImageGaussianPyramid & operator= (ImageGaussianPyramid &&rhs) noexcept
 Move assignment operator.
 
void resize (int roiWidth, int roiHeight, int levels)
 Resizes work buffers.
 
void clear ()
 Resizes work buffers to zero.
 
const MultiscaleImage< T, C > generatePyramid (const T *pSrc, int srcStep, int roiWidth, int roiHeight, int levels)
 Generates a Gaussian image pyramid.
 
void generatePyramid (const T *pSrc, int srcStep, int roiWidth, int roiHeight, int levels, MultiscaleImage< T, C > &dst)
 Generates a Gaussian image pyramid.
 

Related Functions

(Note that these are not member functions.)

BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< uint8_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< uint8_t, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< uint16_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< uint16_t, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< float, 3 >
 

Detailed Description

template<typename T, size_t C>
class blo::ImageGaussianPyramid< T, C >

Gaussian image pyramid processor.

Template Parameters
TData type.
CNumber of channels.

Constructor & Destructor Documentation

◆ ImageGaussianPyramid() [1/4]

template<typename T , size_t C>
blo::ImageGaussianPyramid< T, C >::ImageGaussianPyramid ( )

Default constructor.

◆ ImageGaussianPyramid() [2/4]

template<typename T , size_t C>
blo::ImageGaussianPyramid< T, C >::ImageGaussianPyramid ( int  roiWidth,
int  roiHeight,
int  levels 
)

Constructs Gaussian image pyramid processor of specified size work buffers.

Parameters
roiWidthWidth of the image ROI in pixels to size work buffers to.
roiHeightHeight of the image ROI in pixels to size work buffers to.
levelsNumber of levels of the image pyramid to size work buffers to.

◆ ImageGaussianPyramid() [3/4]

template<typename T , size_t C>
blo::ImageGaussianPyramid< T, C >::ImageGaussianPyramid ( const ImageGaussianPyramid< T, C > &  rhs)

Copy constructor.

◆ ImageGaussianPyramid() [4/4]

template<typename T , size_t C>
blo::ImageGaussianPyramid< T, C >::ImageGaussianPyramid ( ImageGaussianPyramid< T, C > &&  rhs)
noexcept

Move constructor.

◆ ~ImageGaussianPyramid()

template<typename T , size_t C>
virtual blo::ImageGaussianPyramid< T, C >::~ImageGaussianPyramid ( )
virtual

Destructor.

Member Function Documentation

◆ clear()

template<typename T , size_t C>
void blo::ImageGaussianPyramid< T, C >::clear ( )

Resizes work buffers to zero.

◆ generatePyramid() [1/2]

template<typename T , size_t C>
const MultiscaleImage< T, C > blo::ImageGaussianPyramid< T, C >::generatePyramid ( const T *  pSrc,
int  srcStep,
int  roiWidth,
int  roiHeight,
int  levels 
)

Generates a Gaussian image pyramid.

Note
Level 0 of the destination pyramid is a copy of the source image. The remaining levels are the results of decimating the source image, where, for the n-th level, the equivalent of a Gaussian filter with standard deviation 2^(n - 1) is applied prior to downsampling the image. Source image details significantly smaller than two times the standard deviation (2^n) are removed from the image at that level.
Parameters
pSrcPointer to the source image.
srcStepStep in bytes between the rows in the source image.
roiWidthWidth of the source image ROI and destination pyramid in pixels.
roiHeightHeight of the source image ROI and destination pyramid in pixels.
levelsNumber of levels of the image pyramid.
Returns
The destination image pyramid.

◆ generatePyramid() [2/2]

template<typename T , size_t C>
void blo::ImageGaussianPyramid< T, C >::generatePyramid ( const T *  pSrc,
int  srcStep,
int  roiWidth,
int  roiHeight,
int  levels,
MultiscaleImage< T, C > &  dst 
)

Generates a Gaussian image pyramid.

Note
Level 0 of the destination pyramid is a copy of the source image. The remaining levels are the results of decimating the source image, where, for the n-th level, the equivalent of a Gaussian filter with standard deviation 2^(n - 1) is applied prior to downsampling the image. Source image details significantly smaller than two times the standard deviation (2^n) are removed from the image at that level.
Parameters
pSrcPointer to the source image.
srcStepStep in bytes between the rows in the source image.
roiWidthWidth of the source image ROI and destination pyramid in pixels.
roiHeightHeight of the source image ROI and destination pyramid in pixels.
levelsNumber of levels of the image pyramid.
dstThe destination image pyramid.

◆ operator=() [1/2]

template<typename T , size_t C>
ImageGaussianPyramid & blo::ImageGaussianPyramid< T, C >::operator= ( const ImageGaussianPyramid< T, C > &  rhs)

Copy assignment operator.

◆ operator=() [2/2]

template<typename T , size_t C>
ImageGaussianPyramid & blo::ImageGaussianPyramid< T, C >::operator= ( ImageGaussianPyramid< T, C > &&  rhs)
noexcept

Move assignment operator.

◆ resize()

template<typename T , size_t C>
void blo::ImageGaussianPyramid< T, C >::resize ( int  roiWidth,
int  roiHeight,
int  levels 
)

Resizes work buffers.

Parameters
roiWidthWidth of the image ROI in pixels to resize work buffers to.
roiHeightHeight of the image ROI in pixels to resize work buffers to.
levelsNumber of levels of the image pyramid to resize work buffers to.

Friends And Related Function Documentation

◆ ImageGaussianPyramid< float, 1 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< float, 1 >
related

◆ ImageGaussianPyramid< float, 3 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< float, 3 >
related

◆ ImageGaussianPyramid< uint16_t, 1 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< uint16_t, 1 >
related

◆ ImageGaussianPyramid< uint16_t, 3 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< uint16_t, 3 >
related

◆ ImageGaussianPyramid< uint8_t, 1 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< uint8_t, 1 >
related

◆ ImageGaussianPyramid< uint8_t, 3 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageGaussianPyramid< uint8_t, 3 >
related

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