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

Image fast Fourier transform processor. More...

#include <ImageFastFourierTransform.h>

Public Member Functions

 ImageFastFourierTransform ()
 Default constructor.
 
 ImageFastFourierTransform (int width, int height)
 Constructs image fast Fourier transform processor of specified size work buffers.
 
 ImageFastFourierTransform (const ImageFastFourierTransform &rhs)
 Copy constructor.
 
 ImageFastFourierTransform (ImageFastFourierTransform &&rhs) noexcept
 Move constructor.
 
virtual ~ImageFastFourierTransform ()
 Destructor.
 
ImageFastFourierTransform & operator= (const ImageFastFourierTransform &rhs)
 Copy assignment operator.
 
ImageFastFourierTransform & operator= (ImageFastFourierTransform &&rhs) noexcept
 Move assignment operator.
 
void setNormalizationFactor (FourierTransformNormalizationFactor normalizationFactor)
 Sets fast Fourier transform normalization factor.
 
FourierTransformNormalizationFactor normalizationFactor () const
 Retrieves fast Fourier transform normalization factor.
 
void resize (int roiWidth, int roiHeight)
 Resizes work buffers.
 
void clear ()
 Resizes work buffers to zero size.
 
void transformToPacked (const T *pSrc, int srcStep, T *pDst, int dstStep, int roiWidth, int roiHeight)
 Fast Fourier transforms an image.
 
void transformToPacked (T *pSrcDst, int srcDstStep, int roiWidth, int roiHeight)
 Fast Fourier transforms an image.
 
void inverseTransformFromPacked (const T *pSrc, int srcStep, T *pDst, int dstStep, int roiWidth, int roiHeight)
 Inverse fast Fourier transforms an image.
 
void inverseTransformFromPacked (T *pSrcDst, int srcDstStep, int roiWidth, int roiHeight)
 Inverse fast Fourier transforms an image.
 

Related Functions

(Note that these are not member functions.)

BLO_EXPIMP_TEMPLATE template class BLO_API ImageFastFourierTransform< float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFastFourierTransform< float, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFastFourierTransform< float, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFastFourierTransform
 

Detailed Description

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

Image fast Fourier transform processor.

Template Parameters
TData type.
CNumber of channels.

Constructor & Destructor Documentation

◆ ImageFastFourierTransform() [1/4]

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

Default constructor.

◆ ImageFastFourierTransform() [2/4]

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

Constructs image fast Fourier transform processor of specified size work buffers.

Note
The width and height must be zero or a positive integral power of two.
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.

◆ ImageFastFourierTransform() [3/4]

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

Copy constructor.

◆ ImageFastFourierTransform() [4/4]

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

Move constructor.

◆ ~ImageFastFourierTransform()

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

Destructor.

Member Function Documentation

◆ clear()

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

Resizes work buffers to zero size.

◆ inverseTransformFromPacked() [1/2]

template<typename T , size_t C>
void blo::ImageFastFourierTransform< T, C >::inverseTransformFromPacked ( const T *  pSrc,
int  srcStep,
T *  pDst,
int  dstStep,
int  roiWidth,
int  roiHeight 
)

Inverse fast Fourier transforms an image.

Note
The width and height must be zero or a positive integral power of two.
The source image is real-complex packed format.
Parameters
pSrcPointer to the source image.
srcStepStep in bytes between the rows in the source image.
pDstPointer to the destination image.
dstStepStep in bytes between the rows in the destination image.
roiWidthWidth of the source and destination image ROI in pixels.
roiHeightHeight of the source and destination image ROI in pixels.

◆ inverseTransformFromPacked() [2/2]

template<typename T , size_t C>
void blo::ImageFastFourierTransform< T, C >::inverseTransformFromPacked ( T *  pSrcDst,
int  srcDstStep,
int  roiWidth,
int  roiHeight 
)

Inverse fast Fourier transforms an image.

Note
The width and height must be zero or a positive integral power of two.
The source image is real-complex packed format.
Parameters
pSrcDstPointer to the source and destination image.
srcDstStepStep in bytes between the rows in the source and destination image.
roiWidthWidth of the source and destination image ROI in pixels.
roiHeightHeight of the source and destination image ROI in pixels.

◆ normalizationFactor()

template<typename T , size_t C>
FourierTransformNormalizationFactor blo::ImageFastFourierTransform< T, C >::normalizationFactor ( ) const

Retrieves fast Fourier transform normalization factor.

Returns
Fast Fourier transform normalization factor.

◆ operator=() [1/2]

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

Copy assignment operator.

◆ operator=() [2/2]

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

Move assignment operator.

◆ resize()

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

Resizes work buffers.

Note
The width and height must be zero or a positive integral power of two.
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.

◆ setNormalizationFactor()

template<typename T , size_t C>
void blo::ImageFastFourierTransform< T, C >::setNormalizationFactor ( FourierTransformNormalizationFactor  normalizationFactor)

Sets fast Fourier transform normalization factor.

Parameters
normalizationFactorFast Fourier transform normalization factor.

◆ transformToPacked() [1/2]

template<typename T , size_t C>
void blo::ImageFastFourierTransform< T, C >::transformToPacked ( const T *  pSrc,
int  srcStep,
T *  pDst,
int  dstStep,
int  roiWidth,
int  roiHeight 
)

Fast Fourier transforms an image.

Note
The width and height must be zero or a positive integral power of two.
The destination image is real-complex packed format.
Parameters
pSrcPointer to the source image.
srcStepStep in bytes between the rows in the source image.
pDstPointer to the destination image.
dstStepStep in bytes between the rows in the destination image.
roiWidthWidth of the source and destination image ROI in pixels.
roiHeightHeight of the source and destination image ROI in pixels.

◆ transformToPacked() [2/2]

template<typename T , size_t C>
void blo::ImageFastFourierTransform< T, C >::transformToPacked ( T *  pSrcDst,
int  srcDstStep,
int  roiWidth,
int  roiHeight 
)

Fast Fourier transforms an image.

Note
The width and height must be zero or a positive integral power of two.
The destination image is real-complex packed format.
Parameters
pSrcDstPointer to the source and destination image.
srcDstStepStep in bytes between the rows in the source and destination image.
roiWidthWidth of the source and destination image ROI in pixels.
roiHeightHeight of the source and destination image ROI in pixels.

Friends And Related Function Documentation

◆ ImageFastFourierTransform()

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFastFourierTransform< std::complex< float >, 1 >
related

◆ ImageFastFourierTransform< float, 1 >

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

◆ ImageFastFourierTransform< float, 3 >

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

◆ ImageFastFourierTransform< float, 4 >

template<typename T , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFastFourierTransform< float, 4 >
related

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