This class is a child of the vDeformation class implementing a template squeleton. More...

#include <iDeformationTemplate.hh>

Inheritance diagram for iDeformationTemplate:

Collaboration diagram for iDeformationTemplate:

Public Member Functions
	iDeformationTemplate ()
	Constructor of iDeformationTemplate. Simply set all data members to default values.
	~iDeformationTemplate ()
	Destructor of iDeformationTemplate. Free memory from all allocated tabs.
int	ReadAndCheckConfigurationFile (const string &a_fileOptions)
	This function is an implementation of the pure virtual mother function. It is used to read options from a configuration file.
int	ReadAndCheckOptionsList (const string &a_listOptions)
	This function is an implementation of the pure virtual mother function. It is used to read options from a list of options.
int	CheckSpecificParameters ()
	This function is an implementation of the pure virtual mother function. It is used to check parameters of the child deformation model before initialization.
int	Initialize ()
	This function is an implementation of the pure virtual mother function. It is used to initialize specific stuff to the child deformation model.
void	ShowHelp ()
	This function is used to print out specific help about the deformation model and its options.
int	ApplyDeformations (FLTNB ap_inputImage, FLTNB ap_outputImage, int a_direction, int a_defIdx)
	This function is an implementation of the pure virtual mother function. The actual deformation should be implemented here.

Detailed Description

This class is a child of the vDeformation class implementing a template squeleton.

Use this class to implement your own custom deformation model.

Definition at line 24 of file iDeformationTemplate.hh.

Constructor & Destructor Documentation

iDeformationTemplate::iDeformationTemplate ( )

Constructor of iDeformationTemplate. Simply set all data members to default values.

Definition at line 29 of file iDeformationTemplate.cc.

iDeformationTemplate::~iDeformationTemplate ( )

Destructor of iDeformationTemplate. Free memory from all allocated tabs.

Definition at line 44 of file iDeformationTemplate.cc.

Member Function Documentation

int iDeformationTemplate::ApplyDeformations	(	FLTNB *	ap_inputImage,
		FLTNB *	ap_outputImage,
		int	a_direction,
		int	a_defIdx
	)		`[virtual]`

This function is an implementation of the pure virtual mother function. The actual deformation should be implemented here.

Parameters:

ap_inputImage	: input image to deform
ap_outputImage	: image in which the output of the deformation should be recovered
a_direction	: a direction for the deformation to perform (forward or backward)
a_defIdx	: index of the deformation

Returns:: 0 if success, other value otherwise.

Implements vDeformation.

Definition at line 196 of file iDeformationTemplate.cc.

int iDeformationTemplate::CheckSpecificParameters ( ) [virtual]

This function is an implementation of the pure virtual mother function. It is used to check parameters of the child deformation model before initialization.

Returns:: 0 if success, other value otherwise.

Implements vDeformation.

Definition at line 134 of file iDeformationTemplate.cc.

int iDeformationTemplate::Initialize ( ) [virtual]

This function is an implementation of the pure virtual mother function. It is used to initialize specific stuff to the child deformation model.

Returns:: 0 if success, other value otherwise.

Implements vDeformation.

Definition at line 161 of file iDeformationTemplate.cc.

int iDeformationTemplate::ReadAndCheckConfigurationFile ( const string & a_fileOptions ) [virtual]

This function is an implementation of the pure virtual mother function. It is used to read options from a configuration file.

Parameters:

a_configurationFile : ASCII file containing informations about a dynamic model

Returns:: 0 if success, other value otherwise.

Implements vDeformation.

Definition at line 81 of file iDeformationTemplate.cc.

int iDeformationTemplate::ReadAndCheckOptionsList ( const string & a_listOptions ) [virtual]

This function is an implementation of the pure virtual mother function. It is used to read options from a list of options.

Parameters:

a_optionsList : a list of parameters separated by commas

Returns:: 0 if success, other value otherwise.

Implements vDeformation.

Definition at line 108 of file iDeformationTemplate.cc.

void iDeformationTemplate::ShowHelp ( ) [virtual]

This function is used to print out specific help about the deformation model and its options.

Implements vDeformation.

Definition at line 59 of file iDeformationTemplate.cc.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation