SourceXtractor::DFTConvolution< T, TPadding > Class Template Reference

#include <DFT.h>

Collaboration diagram for SourceXtractor::DFTConvolution< T, TPadding >:

Classes
struct	ConvolutionContext

Public Types
typedef T	real_t
typedef FFT< T >::complex_t	complex_t

Public Member Functions
	DFTConvolution (std::shared_ptr< const Image< T >> img)
virtual	~DFTConvolution ()=default
std::size_t	getWidth () const
std::size_t	getHeight () const
std::unique_ptr< ConvolutionContext >	prepare (const std::shared_ptr< Image< T >> model_ptr) const
template<typename ... Args>
void	convolve (std::shared_ptr< WriteableImage< T >> image_ptr, std::unique_ptr< ConvolutionContext > &context, Args... padding_args) const
template<typename ... Args>
void	convolve (std::shared_ptr< WriteableImage< T >> image_ptr, Args... padding_args) const
std::shared_ptr< const Image< T > >	getKernel () const

Protected Member Functions
void	padKernel (int width, int height, typename std::vector< T >::iterator out) const
void	dumpImage (const std::shared_ptr< const Image< T >> &img, typename std::vector< T >::iterator out) const

Private Attributes
std::shared_ptr< const Image< T > >	m_kernel

Detailed Description

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>
class SourceXtractor::DFTConvolution< T, TPadding >

Convolution strategy based on the Discrete Fourier Transform

Template Parameters

T	The pixel type
TPadding	The padding strategy

Definition at line 46 of file DFT.h.

Member Typedef Documentation

complex_t

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

typedef FFT<T>::complex_t SourceXtractor::DFTConvolution< T, TPadding >::complex_t

Definition at line 49 of file DFT.h.

real_t

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

typedef T SourceXtractor::DFTConvolution< T, TPadding >::real_t

Definition at line 48 of file DFT.h.

Constructor & Destructor Documentation

DFTConvolution()

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

SourceXtractor::DFTConvolution< T, TPadding >::DFTConvolution ( std::shared_ptr< const Image< T >>  img )

inline

Constructor

Parameters

img	Convolution kernel

Definition at line 71 of file DFT.h.

~DFTConvolution()

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

virtual SourceXtractor::DFTConvolution< T, TPadding >::~DFTConvolution ( )

virtualdefault

Destructor

Member Function Documentation

convolve() [1/2]

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

template<typename ... Args>

void SourceXtractor::DFTConvolution< T, TPadding >::convolve ( std::shared_ptr< WriteableImage< T >>  image_ptr, std::unique_ptr< ConvolutionContext > &  context, Args...  padding_args  ) const

inline

Convolve the image with the stored kernel, using the given context storing the pre-computed kernel transform, and pre-allocated buffers

Template Parameters

Args	Types of the parameters to be forwarded to the padding strategy

Parameters

image_ptr	The image to convolve
context	The prepared context
padding_args	Forwarded to the padding strategy

Definition at line 151 of file DFT.h.

Referenced by SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::convolve(), and SourceXtractor::BgDFTConvolutionImageSource::generateTile().

convolve() [2/2]

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

template<typename ... Args>

void SourceXtractor::DFTConvolution< T, TPadding >::convolve ( std::shared_ptr< WriteableImage< T >>  image_ptr, Args...  padding_args  ) const

inline

Convolve the image with the stored kernel

Template Parameters

Args	Types of the parameters to be forwarded to the padding strategy

Parameters

image_ptr	The image to convolve
padding_args	Forwarded to the padding strategy

Note

The context will be computed on the fly, and discarded. If multiple, similar, convolutions are to be done, use a combination of prepare/convolve

Definition at line 207 of file DFT.h.

dumpImage()

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

void SourceXtractor::DFTConvolution< T, TPadding >::dumpImage ( const std::shared_ptr< const Image< T >> &  img, typename std::vector< T >::iterator  out  ) const

inlineprotected

Definition at line 231 of file DFT.h.

Referenced by SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::convolve(), and SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::padKernel().

getHeight()

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

std::size_t SourceXtractor::DFTConvolution< T, TPadding >::getHeight ( ) const

inline

Returns

The height of the kernel

Definition at line 92 of file DFT.h.

Referenced by SourceXtractor::BgDFTConvolutionImageSource::generateTile().

getKernel()

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

std::shared_ptr<const Image<T> > SourceXtractor::DFTConvolution< T, TPadding >::getKernel ( ) const

inline

Returns

The convolution kernel

Definition at line 216 of file DFT.h.

getWidth()

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

std::size_t SourceXtractor::DFTConvolution< T, TPadding >::getWidth ( ) const

inline

Returns

The width of the kernel

Definition at line 84 of file DFT.h.

Referenced by SourceXtractor::BgDFTConvolutionImageSource::generateTile().

padKernel()

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

void SourceXtractor::DFTConvolution< T, TPadding >::padKernel ( int  width, int  height, typename std::vector< T >::iterator  out  ) const

inlineprotected

Definition at line 221 of file DFT.h.

Referenced by SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::prepare().

prepare()

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

std::unique_ptr<ConvolutionContext> SourceXtractor::DFTConvolution< T, TPadding >::prepare ( const std::shared_ptr< Image< T >>  model_ptr ) const

inline

Pre-computes the transform of the kernel, adapted to the image passed by model_ptr

Parameters

model_ptr

Reference image. Only its size is used to compute the necessary padding, and kernel size before transformation

Returns

A context than can be used by convolve to avoid re-computing the kernel multiple times

Definition at line 104 of file DFT.h.

Referenced by SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::convolve().

Member Data Documentation

m_kernel

template<typename T = SeFloat, class TPadding = PaddedImage<T, Reflect101Coordinates>>

std::shared_ptr<const Image<T> > SourceXtractor::DFTConvolution< T, TPadding >::m_kernel

private

Definition at line 240 of file DFT.h.

Referenced by SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::getHeight(), SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::getKernel(), SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::getWidth(), SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::padKernel(), and SourceXtractor::DFTConvolution< DetectionImage::PixelType, PaddedType >::prepare().

---

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

• SEFramework/SEFramework/Convolution/DFT.h