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

Image wavelet transform processor. More...

#include <ImageWaveletTransform.h>

Public Member Functions

 ImageWaveletTransform ()
 Default constructor.
 
 ImageWaveletTransform (int width, int height, int kernelLen)
 Constructs image wavelet transform processor of specified size work buffers.
 
 ImageWaveletTransform (const ImageWaveletTransform &rhs)
 Copy constructor.
 
 ImageWaveletTransform (ImageWaveletTransform &&rhs) noexcept
 Move constructor.
 
virtual ~ImageWaveletTransform ()
 Destructor.
 
ImageWaveletTransform & operator= (const ImageWaveletTransform &rhs)
 Copy assignment operator.
 
ImageWaveletTransform & operator= (ImageWaveletTransform &&rhs) noexcept
 Move assignment operator.
 
void setBorderType (Border border)
 Sets border type.
 
Border borderType () const
 Retrieves border type.
 
void setFilters (const float *pKernelLow, int kernelLowLen, int kernelLowAnchor, const float *pKernelHigh, int kernelHighLen, int kernelHighAnchor, const float *pInverseKernelLow, int inverseKernelLowLen, int inverseKernelLowAnchor, const float *pInverseKernelHigh, int inverseKernelHighLen, int inverseKernelHighAnchor)
 Sets wavelet transform filters.
 
void resize (int roiWidth, int roiHeight, int kernelLen)
 Resizes work buffers.
 
void clear ()
 Resizes work buffers to zero size.
 
void transformedSize (int srcRoiWidth, int srcRoiHeight, int &dstRoiWidth, int &dstRoiHeight)
 Calculates the size of the transformed image.
 
void transform (const T *pSrc, int srcStep, int srcRoiWidth, int srcRoiHeight, T *pDstApprox, int dstApproxStep, T *pDstHdetail, int dstHdetailStep, T *pDstVdetail, int dstVdetailStep, T *pDstDdetail, int dstDdetailStep)
 Wavelet transforms an image.
 
void decomposeImage (const T *pSrc, int srcStep, int srcRoiWidth, int srcRoiHeight, int levels, MultiscaleImage< T, C > &dstHdetailPyramid, MultiscaleImage< T, C > &dstVdetailPyramid, MultiscaleImage< T, C > &dstDdetailPyramid, Image< T, C > &dstImage)
 Decomposes an image to an approximation image and detail image pyramids.
 
void inverseTransformedSize (int srcRoiWidth, int srcRoiHeight, int &dstRoiWidth, int &dstRoiHeight)
 Calculates the size of the inverse transformed image.
 
void inverseTransform (const T *pSrcApprox, int srcApproxStep, const T *pSrcHdetail, int srcHdetailStep, const T *pSrcVdetail, int srcVdetailStep, const T *pSrcDdetail, int srcDdetailStep, int srcRoiWidth, int srcRoiHeight, T *pDst, int dstStep)
 Inverse wavelet transforms an image.
 
void reconstructImage (const T *pSrcImage, int srcImageStep, const MultiscaleImage< T, C > &srcHdetailPyramid, const MultiscaleImage< T, C > &srcVdetailPyramid, const MultiscaleImage< T, C > &srcDdetailPyramid, T *pDst, int dstStep, int level=0)
 Reconstructs an image from an approximation image and detail image pyramids.
 

Related Functions

(Note that these are not member functions.)

BLO_EXPIMP_TEMPLATE template class BLO_API ImageWaveletTransform< float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageWaveletTransform< float, 3 >
 

Detailed Description

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

Image wavelet transform processor.

Template Parameters
TData type.
CNumber of channels.

Constructor & Destructor Documentation

◆ ImageWaveletTransform() [1/4]

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

Default constructor.

◆ ImageWaveletTransform() [2/4]

template<typename T , size_t C>
blo::ImageWaveletTransform< T, C >::ImageWaveletTransform ( int  width,
int  height,
int  kernelLen 
)

Constructs image wavelet transform processor of specified size work buffers.

Parameters
widthWidth of the image ROI in pixels to size work buffers to.
heightHeight of the image ROI in pixels to size work buffers to.
kernelLenLength of the filter kernel in pixels to resize work buffers to.

◆ ImageWaveletTransform() [3/4]

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

Copy constructor.

◆ ImageWaveletTransform() [4/4]

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

Move constructor.

◆ ~ImageWaveletTransform()

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

Destructor.

Member Function Documentation

◆ borderType()

template<typename T , size_t C>
Border blo::ImageWaveletTransform< T, C >::borderType ( ) const

Retrieves border type.

Returns
Border type.

◆ clear()

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

Resizes work buffers to zero size.

◆ decomposeImage()

template<typename T , size_t C>
void blo::ImageWaveletTransform< T, C >::decomposeImage ( const T *  pSrc,
int  srcStep,
int  srcRoiWidth,
int  srcRoiHeight,
int  levels,
MultiscaleImage< T, C > &  dstHdetailPyramid,
MultiscaleImage< T, C > &  dstVdetailPyramid,
MultiscaleImage< T, C > &  dstDdetailPyramid,
Image< T, C > &  dstImage 
)

Decomposes an image to an approximation image and detail image pyramids.

Parameters
pSrcPointer to the source image.
srcStepStep in bytes between the rows in the source image.
srcRoiWidthWidth of the source image ROI in pixels.
srcRoiHeightHeight of the source image ROI in pixels.
levelsNumber of levels to decompose the image.
dstHdetailPyramidThe destination horizontal detail image pyramid.
dstVdetailPyramidThe destination vertical detail image pyramid.
dstDdetailPyramidThe destination diagonal detail image pyramid.
dstImageThe destination approximation image corresponding to the last level in the detail image pyramids.

◆ inverseTransform()

template<typename T , size_t C>
void blo::ImageWaveletTransform< T, C >::inverseTransform ( const T *  pSrcApprox,
int  srcApproxStep,
const T *  pSrcHdetail,
int  srcHdetailStep,
const T *  pSrcVdetail,
int  srcVdetailStep,
const T *  pSrcDdetail,
int  srcDdetailStep,
int  srcRoiWidth,
int  srcRoiHeight,
T *  pDst,
int  dstStep 
)

Inverse wavelet transforms an image.

Parameters
pSrcApproxPointer to the source approximation image.
srcApproxStepStep in bytes between the rows in the source approximation image.
pSrcHdetailPointer to the source horizontal detail image.
srcHdetailStepStep in bytes between the rows in the source horizontal detail image.
pSrcVdetailPointer to the source vertical detail image.
srcVdetailStepStep in bytes between the rows in the source vertical detail image.
pSrcDdetailPointer to the destination source detail image.
srcDdetailStepStep in bytes between the rows in the source diagonal detail image.
srcRoiWidthWidth of the source images ROI in pixels.
srcRoiHeightHeight of the source images ROI in pixels.
pDstPointer to the destination image.
dstStepStep in bytes between the rows in the destination image.

◆ inverseTransformedSize()

template<typename T , size_t C>
void blo::ImageWaveletTransform< T, C >::inverseTransformedSize ( int  srcRoiWidth,
int  srcRoiHeight,
int &  dstRoiWidth,
int &  dstRoiHeight 
)

Calculates the size of the inverse transformed image.

Parameters
srcRoiWidthWidth of the source image ROI in pixels.
srcRoiHeightHeight of the source image ROI in pixels.
dstRoiWidthWidth of the inverse transformed image ROI in pixels.
dstRoiHeightHeight of the inverse transformed image ROI in pixels.

◆ operator=() [1/2]

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

Copy assignment operator.

◆ operator=() [2/2]

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

Move assignment operator.

◆ reconstructImage()

template<typename T , size_t C>
void blo::ImageWaveletTransform< T, C >::reconstructImage ( const T *  pSrcImage,
int  srcImageStep,
const MultiscaleImage< T, C > &  srcHdetailPyramid,
const MultiscaleImage< T, C > &  srcVdetailPyramid,
const MultiscaleImage< T, C > &  srcDdetailPyramid,
T *  pDst,
int  dstStep,
int  level = 0 
)

Reconstructs an image from an approximation image and detail image pyramids.

Parameters
pSrcImagePointer to the source approximation image corresponding to the last level in the detail image pyramids.
srcImageStepStep in bytes between the rows in the source approximation image.
srcHdetailPyramidThe source horizontal detail image pyramid.
srcVdetailPyramidThe source vertical detail image pyramid.
srcDdetailPyramidThe source diagonal detail image pyramid.
pDstPointer to the destination image.
dstStepStep in bytes between the rows in the destination image.
levelLevel to reconstruct.

◆ resize()

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

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.
kernelLenLength of the filter kernel in pixels to resize work buffers to.

◆ setBorderType()

template<typename T , size_t C>
void blo::ImageWaveletTransform< T, C >::setBorderType ( Border  border)

Sets border type.

Parameters
borderBorder type.

◆ setFilters()

template<typename T , size_t C>
void blo::ImageWaveletTransform< T, C >::setFilters ( const float *  pKernelLow,
int  kernelLowLen,
int  kernelLowAnchor,
const float *  pKernelHigh,
int  kernelHighLen,
int  kernelHighAnchor,
const float *  pInverseKernelLow,
int  inverseKernelLowLen,
int  inverseKernelLowAnchor,
const float *  pInverseKernelHigh,
int  inverseKernelHighLen,
int  inverseKernelHighAnchor 
)

Sets wavelet transform filters.

Note
The image wavelet transform processor filters an image using convolution.
Parameters
pKernelLowPointer to the transform low pass filter kernel values.
kernelLowLenLength of the transform low pass filter kernel in pixels.
kernelLowAnchorAnchor cell specifying the transform low pass filter kernel alignment with respect to the position of the input pixel.
pKernelHighPointer to the transform high pass filter kernel values.
kernelHighLenLength of the transform high pass filter kernel in pixels.
kernelHighAnchorAnchor cell specifying the transform high pass filter kernel alignment with respect to the position of the input pixel.
pInverseKernelLowPointer to the inverse transform low pass filter kernel values.
inverseKernelLowLenLength of the inverse transform low pass filter kernel in pixels.
inverseKernelLowAnchorAnchor cell specifying the inverse transform low pass filter kernel alignment with respect to the position of the input pixel.
pInverseKernelHighPointer to the inverse transform high pass filter kernel values.
inverseKernelHighLenLength of the inverse transform high pass filter kernel in pixels.
inverseKernelHighAnchorAnchor cell specifying the inverse transform high pass filter kernel alignment with respect to the position of the input pixel.

◆ transform()

template<typename T , size_t C>
void blo::ImageWaveletTransform< T, C >::transform ( const T *  pSrc,
int  srcStep,
int  srcRoiWidth,
int  srcRoiHeight,
T *  pDstApprox,
int  dstApproxStep,
T *  pDstHdetail,
int  dstHdetailStep,
T *  pDstVdetail,
int  dstVdetailStep,
T *  pDstDdetail,
int  dstDdetailStep 
)

Wavelet transforms an image.

Parameters
pSrcPointer to the source image.
srcStepStep in bytes between the rows in the source image.
srcRoiWidthWidth of the source image ROI in pixels.
srcRoiHeightHeight of the source image ROI in pixels.
pDstApproxPointer to the destination approximation image.
dstApproxStepStep in bytes between the rows in the destination approximation image.
pDstHdetailPointer to the destination horizontal detail image.
dstHdetailStepStep in bytes between the rows in the destination horizontal detail image.
pDstVdetailPointer to the destination vertical detail image.
dstVdetailStepStep in bytes between the rows in the destination vertical detail image.
pDstDdetailPointer to the destination diagonal detail image.
dstDdetailStepStep in bytes between the rows in the destination diagonal detail image.

◆ transformedSize()

template<typename T , size_t C>
void blo::ImageWaveletTransform< T, C >::transformedSize ( int  srcRoiWidth,
int  srcRoiHeight,
int &  dstRoiWidth,
int &  dstRoiHeight 
)

Calculates the size of the transformed image.

Parameters
srcRoiWidthWidth of the source image ROI in pixels.
srcRoiHeightHeight of the source image ROI in pixels.
dstRoiWidthWidth of the transformed image ROI in pixels.
dstRoiHeightHeight of the transformed image ROI in pixels.

Friends And Related Function Documentation

◆ ImageWaveletTransform< float, 1 >

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

◆ ImageWaveletTransform< float, 3 >

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

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