This class is an image convolver module implementing stationary gaussian filtering. More...

#include <iImageConvolverStationaryGaussian.hh>

Inheritance diagram for iImageConvolverStationaryGaussian:

Collaboration diagram for iImageConvolverStationaryGaussian:

Public Member Functions
	iImageConvolverStationaryGaussian ()
	The constructor of iImageConvolverStationaryGaussian.
	~iImageConvolverStationaryGaussian ()
	The destructor of iImageConvolverStationaryGaussian.
int	ReadConfigurationFile (const string &a_fileOptions)
	A function used to read options from a configuration file.
int	ReadOptionsList (const string &a_listOptions)
	A function used to read options from a list of options.
void	ShowHelp ()
	A function used to show help about the child module.
Protected Attributes
FLTNB	m_transFWHM
FLTNB	m_axialFWHM
FLTNB	m_nbSigmas
INTNB	m_dimKernelXY
INTNB	m_dimKernelXYZ
Private Member Functions
int	CheckSpecificParameters ()
	A private function used to check the parameters settings specific to the child module.
int	BuildConvolutionKernel ()
	A private function used to build the convolution kernel specific to the child convolver.

Detailed Description

This class is an image convolver module implementing stationary gaussian filtering.

This class is a child of vImageConvolver. It implements a stationary gaussian convolution filter, parameterized by a transaxial and an axial FWHM, as well as the number of sigmas to be included in the convolution kernel.

Definition at line 27 of file iImageConvolverStationaryGaussian.hh.

Constructor & Destructor Documentation

iImageConvolverStationaryGaussian::iImageConvolverStationaryGaussian ( )

The constructor of iImageConvolverStationaryGaussian.

This is the default and unique constructor. It does not take any parameter and its role is to affect default values to parameters specific to this module.

Definition at line 28 of file iImageConvolverStationaryGaussian.cc.

iImageConvolverStationaryGaussian::~iImageConvolverStationaryGaussian ( )

The destructor of iImageConvolverStationaryGaussian.

This is the default and unique destructor. It does not take any parameter and its role is only to free or delete all structures that were built specifically by this module. Here it does nothing.

Definition at line 42 of file iImageConvolverStationaryGaussian.cc.

Member Function Documentation

int iImageConvolverStationaryGaussian::BuildConvolutionKernel ( ) [private, virtual]

A private function used to build the convolution kernel specific to the child convolver.

This function is used to build the convolution kernels associated to the child convolver. It is called by the Initialize() function. It is the implementation of the pure virtual function inherited from the abstract mother class vImageConvolver. In this case, the kernel is stationary so m_nbKernels = 1. We keep the implementation of the convolution from the mother class which already implements stationary convolutions.

Returns:: An integer reflecting the building status; 0 if no problem, another value otherwise.

Implements vImageConvolver.

Definition at line 152 of file iImageConvolverStationaryGaussian.cc.

Here is the call graph for this function:

int iImageConvolverStationaryGaussian::CheckSpecificParameters ( ) [private, virtual]

A private function used to check the parameters settings specific to the child module.

This function is used to check that all parameters specific to the module are correctly set within allowed values. It is called by the CheckParameters() function of the mother class. It is the implementation of the pure virtual function inherited from the abstract mother class vImageConvolver.

Returns:: An integer reflecting the check status; 0 if no problem, another value otherwise.

Implements vImageConvolver.

Definition at line 123 of file iImageConvolverStationaryGaussian.cc.

int iImageConvolverStationaryGaussian::ReadConfigurationFile ( const string & a_fileOptions ) [virtual]

A function used to read options from a configuration file.

Parameters:

const string& a_configurationFile

This function implements the reading of all options associated to a child module, from a configuration file. It is the implementation of the pure virtual function inherited from the abstract class vImageConvolver. It checks the reading status but not the options values that will be checked by the CheckSpecificParameters() function.

Returns:: An integer reflecting the reading success; 0 if success, another value otherwise.

Implements vImageConvolver.

Definition at line 67 of file iImageConvolverStationaryGaussian.cc.

Here is the call graph for this function:

int iImageConvolverStationaryGaussian::ReadOptionsList ( const string & a_listOptions ) [virtual]

A function used to read options from a list of options.

Parameters:

const string& a_configurationFile

This function implements the reading of all options associated to a child module, from a list of options. It is the implementation of the pure virtual function inherited from the abstract class vImageConvolver. It checks the reading status but not the options values that will be checked by the CheckSpecificParameters() function.

Returns:: An integer reflecting the reading success; 0 if success, another value otherwise.

Implements vImageConvolver.

Definition at line 100 of file iImageConvolverStationaryGaussian.cc.

Here is the call graph for this function:

void iImageConvolverStationaryGaussian::ShowHelp ( ) [virtual]

A function used to show help about the child module.

This function must describe what the module does and how to use it. It describes in details the different parameters of the module, and how to set them through the use of a configuration file or a list of options. It is the implementation of the pure virtual function inherited from the abstract class vImageConvolverModule.

Implements vImageConvolver.

Definition at line 51 of file iImageConvolverStationaryGaussian.cc.