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

Image filter processor. More...

#include <ImageFilter.h>

Public Member Functions

 ImageFilter ()
 Default constructor.
 
 ImageFilter (int dstRoiWidth, int dstRoiHeight, int kernelWidth, int kernelHeight)
 Constructs image filter processor of specified size work buffers.
 
 ImageFilter (const ImageFilter &rhs)
 Copy constructor.
 
 ImageFilter (ImageFilter &&rhs) noexcept
 Move constructor.
 
virtual ~ImageFilter ()
 Destructor.
 
ImageFilter & operator= (const ImageFilter &rhs)
 Copy assignment operator.
 
ImageFilter & operator= (ImageFilter &&rhs) noexcept
 Move assignment operator.
 
void setBorderType (Border border)
 Sets border type.
 
Border borderType () const
 Retrieves border type.
 
void resize (int dstRoiWidth, int dstRoiHeight, int kernelWidth, int kernelHeight)
 Resizes work buffers.
 
void clear ()
 Resizes work buffers to zero.
 
void filter (const T *pSrc, int srcStep, T *pDst, int dstStep, int dstRoiWidth, int dstRoiHeight, const U *pKernel, int kernelWidth, int kernelHeight)
 Filters an image.
 

Related Functions

(Note that these are not member functions.)

BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, double, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, int16_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, double, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, int16_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, double, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, int16_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, double, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, int16_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< double, double, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< double, float, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< double, int16_t, 1 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, double, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, float, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, int16_t, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, double, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, float, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, int16_t, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, double, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, float, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, int16_t, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, double, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, float, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, int16_t, 3 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, double, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, float, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, int16_t, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, double, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, float, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, int16_t, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, double, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, float, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, int16_t, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, double, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, float, 4 >
 
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, int16_t, 4 >
 

Detailed Description

template<typename T, typename U, size_t C>
class blo::ImageFilter< T, U, C >

Image filter processor.

Template Parameters
TData type of image.
UData type of kernel.
CNumber of channels.

Constructor & Destructor Documentation

◆ ImageFilter() [1/4]

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

Default constructor.

◆ ImageFilter() [2/4]

template<typename T , typename U , size_t C>
blo::ImageFilter< T, U, C >::ImageFilter ( int  dstRoiWidth,
int  dstRoiHeight,
int  kernelWidth,
int  kernelHeight 
)

Constructs image filter processor of specified size work buffers.

Parameters
dstRoiWidthWidth of the destination image ROI in pixels to size work buffers to.
dstRoiHeightHeight of the destination image ROI in pixels to size work buffers to.
kernelWidthWidth of the kernel in pixels to size work buffers to.
kernelHeightHeight of the kernel in pixels to size work buffers to.

◆ ImageFilter() [3/4]

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

Copy constructor.

◆ ImageFilter() [4/4]

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

Move constructor.

◆ ~ImageFilter()

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

Destructor.

Member Function Documentation

◆ borderType()

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

Retrieves border type.

Returns
Border type.

◆ clear()

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

Resizes work buffers to zero.

◆ filter()

template<typename T , typename U , size_t C>
void blo::ImageFilter< T, U, C >::filter ( const T *  pSrc,
int  srcStep,
T *  pDst,
int  dstStep,
int  dstRoiWidth,
int  dstRoiHeight,
const U *  pKernel,
int  kernelWidth,
int  kernelHeight 
)

Filters an image.

Note
This function filters an image using cross-correlation.
The kernel anchor is (floor((kernelWidth - 1) / 2, floor((kernelHeight - 1) / 2)^T.
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.
dstRoiWidthWidth of the destination image ROI in pixels.
dstRoiHeightHeight of the destination image ROI in pixels.
pKernelPointer to the kernel values.
kernelWidthWidth of the kernel in pixels.
kernelHeightHeight of the kernel in pixels.

◆ operator=() [1/2]

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

Copy assignment operator.

◆ operator=() [2/2]

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

Move assignment operator.

◆ resize()

template<typename T , typename U , size_t C>
void blo::ImageFilter< T, U, C >::resize ( int  dstRoiWidth,
int  dstRoiHeight,
int  kernelWidth,
int  kernelHeight 
)

Resizes work buffers.

Parameters
dstRoiWidthWidth of the destination image ROI in pixels to resize work buffers to.
dstRoiHeightHeight of the destination image ROI in pixels to resize work buffers to.
kernelWidthWidth of the kernel in pixels to resize work buffers to.
kernelHeightHeight of the kernel in pixels to resize work buffers to.

◆ setBorderType()

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

Sets border type.

Parameters
borderBorder type.
Note
If border type is Border::inMemory, then the source image ROI is (dstRoiWidth + kernelWidth - 1)-by-(dstRoiHeight + kernelHeight - 1); otherwise, the source image ROI is the same size as the destination image ROI.

Friends And Related Function Documentation

◆ ImageFilter< double, double, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< double, double, 1 >
related

◆ ImageFilter< double, float, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< double, float, 1 >
related

◆ ImageFilter< double, int16_t, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< double, int16_t, 1 >
related

◆ ImageFilter< float, double, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, double, 1 >
related

◆ ImageFilter< float, double, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, double, 3 >
related

◆ ImageFilter< float, double, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, double, 4 >
related

◆ ImageFilter< float, float, 1 >

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

◆ ImageFilter< float, float, 3 >

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

◆ ImageFilter< float, float, 4 >

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

◆ ImageFilter< float, int16_t, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, int16_t, 1 >
related

◆ ImageFilter< float, int16_t, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, int16_t, 3 >
related

◆ ImageFilter< float, int16_t, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< float, int16_t, 4 >
related

◆ ImageFilter< int16_t, double, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, double, 1 >
related

◆ ImageFilter< int16_t, double, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, double, 3 >
related

◆ ImageFilter< int16_t, double, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, double, 4 >
related

◆ ImageFilter< int16_t, float, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, float, 1 >
related

◆ ImageFilter< int16_t, float, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, float, 3 >
related

◆ ImageFilter< int16_t, float, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, float, 4 >
related

◆ ImageFilter< int16_t, int16_t, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, int16_t, 1 >
related

◆ ImageFilter< int16_t, int16_t, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, int16_t, 3 >
related

◆ ImageFilter< int16_t, int16_t, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< int16_t, int16_t, 4 >
related

◆ ImageFilter< uint16_t, double, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, double, 1 >
related

◆ ImageFilter< uint16_t, double, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, double, 3 >
related

◆ ImageFilter< uint16_t, double, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, double, 4 >
related

◆ ImageFilter< uint16_t, float, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, float, 1 >
related

◆ ImageFilter< uint16_t, float, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, float, 3 >
related

◆ ImageFilter< uint16_t, float, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, float, 4 >
related

◆ ImageFilter< uint16_t, int16_t, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, int16_t, 1 >
related

◆ ImageFilter< uint16_t, int16_t, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, int16_t, 3 >
related

◆ ImageFilter< uint16_t, int16_t, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint16_t, int16_t, 4 >
related

◆ ImageFilter< uint8_t, double, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, double, 1 >
related

◆ ImageFilter< uint8_t, double, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, double, 3 >
related

◆ ImageFilter< uint8_t, double, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, double, 4 >
related

◆ ImageFilter< uint8_t, float, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, float, 1 >
related

◆ ImageFilter< uint8_t, float, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, float, 3 >
related

◆ ImageFilter< uint8_t, float, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, float, 4 >
related

◆ ImageFilter< uint8_t, int16_t, 1 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, int16_t, 1 >
related

◆ ImageFilter< uint8_t, int16_t, 3 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, int16_t, 3 >
related

◆ ImageFilter< uint8_t, int16_t, 4 >

template<typename T , typename U , size_t C>
BLO_EXPIMP_TEMPLATE template class BLO_API ImageFilter< uint8_t, int16_t, 4 >
related

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