This class is a template for penalties. More...

#include <iPenaltyTemplate.hh>

Inheritance diagram for iPenaltyTemplate:

Collaboration diagram for iPenaltyTemplate:

Public Member Functions
	iPenaltyTemplate ()
	The constructor of iPenaltyTemplate. More...

	~iPenaltyTemplate ()
	The destructor of iPenaltyTemplate. More...

int	ReadConfigurationFile (const string &a_configurationFile)
	A function used to read options from a configuration file. More...

int	ReadOptionsList (const string &a_optionsList)
	A function used to read options from a list of options. More...

FLTNB	ComputePenaltyValue (int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)
	Implementation of the pure virtual vPenalty::ComputePenaltyValue() More...

FLTNB	ComputeFirstDerivative (int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)
	Implementation of the pure virtual vPenalty::ComputeFirstDerivative() More...

FLTNB	ComputeSecondDerivative (int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)
	Implementation of the pure virtual vPenalty::ComputeSecondDerivative() More...

Public Member Functions inherited from vPenalty
	vPenalty ()
	The constructor of vPenalty. More...

virtual	~vPenalty ()
	The destructor of vPenalty. More...

void	ShowHelp ()
	A function used to show help about the penalty. More...

int	CheckParameters ()
	A public function used to check the parameters settings. More...

int	Initialize ()
	A public function used to initialize the penalty. More...

virtual int	GlobalPreProcessingStep ()
	A public function computing a global pre-processing step for the penalty. More...

virtual int	LocalPreProcessingStep (int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)
	A public function computing a local pre-processing step for the penalty. More...

void	SetVerbose (int a_verbose)
	Set the verbose level. More...

void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)
	Set the pointer to the image dimensions in use. More...

void	SetImageSpace (oImageSpace *ap_ImageSpace)
	Set the pointer to the image space in use. More...

void	SetPenaltyStrength (FLTNB a_penaltyStrength)
	Set the penalty strength. More...

FLTNB	GetPenaltyStrength ()
	Get the penalty strength. More...

int	GetPenaltyDerivativesOrder ()
	Get the penalty deratives order. More...

void	SetPenaltyID (const string &a_penaltyID)
	Set the penalty ID. More...

const string &	GetPenaltyID ()

Private Member Functions
void	ShowHelpSpecific ()
	A function used to show help about the child penalty. More...

int	CheckSpecificParameters ()
	A private function used to check the parameters settings specific to the child penalty. More...

int	InitializeSpecific ()
	This function is used to initialize specific stuff to the child penalty. More...

Additional Inherited Members
Protected Attributes inherited from vPenalty
string	m_penaltyID

oImageDimensionsAndQuantification *	mp_ImageDimensionsAndQuantification

oImageSpace *	mp_ImageSpace

int	m_verbose

int	m_penaltyDerivativesOrder

FLTNB	m_penaltyStrength

Detailed Description

This class is a template for penalties.

This class inherits from vPenalty and provides details on how to implement a penalty.

Definition at line 42 of file iPenaltyTemplate.hh.

Constructor & Destructor Documentation

◆ iPenaltyTemplate()

iPenaltyTemplate::iPenaltyTemplate ( )

The constructor of iPenaltyTemplate.

This is the default and unique constructor. It does not take any parameter and its role is only to affect default values to each member of the class.

Definition at line 37 of file iPenaltyTemplate.cc.

◆ ~iPenaltyTemplate()

iPenaltyTemplate::~iPenaltyTemplate ( )

The destructor of iPenaltyTemplate.

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 by this class.

Definition at line 62 of file iPenaltyTemplate.cc.

Member Function Documentation

◆ CheckSpecificParameters()

int iPenaltyTemplate::CheckSpecificParameters ( )

privatevirtual

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

This function is used to check that all parameters specific to the penalty 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 vPenalty.

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

Implements vPenalty.

Definition at line 115 of file iPenaltyTemplate.cc.

◆ ComputeFirstDerivative()

FLTNB iPenaltyTemplate::ComputeFirstDerivative	(	int	a_tbf,
		int	a_rbf,
		int	a_cbf,
		INTNB	a_voxel,
		int	a_th
	)

virtual

Implementation of the pure virtual vPenalty::ComputeFirstDerivative()

Parameters

int	a_tbf
int	a_rbf
int	a_cbf
INTNB	a_voxel
int	a_th

This function computes the first derivative of the penalty. It is the implementation of the pure virtual vPenalty::ComputeFirstDerivative().

Returns: The derivative

Implements vPenalty.

Definition at line 161 of file iPenaltyTemplate.cc.

◆ ComputePenaltyValue()

FLTNB iPenaltyTemplate::ComputePenaltyValue	(	int	a_tbf,
		int	a_rbf,
		int	a_cbf,
		INTNB	a_voxel,
		int	a_th
	)

virtual

Implementation of the pure virtual vPenalty::ComputePenaltyValue()

Parameters

int	a_tbf
int	a_rbf
int	a_cbf
INTNB	a_voxel
int	a_th

This function computes the value of the penalty function for the provided indices. It is the implementation of the pure virtual vPenalty::ComputePenaltyValue().

Returns: The penalty value

Implements vPenalty.

Definition at line 146 of file iPenaltyTemplate.cc.

◆ ComputeSecondDerivative()

FLTNB iPenaltyTemplate::ComputeSecondDerivative	(	int	a_tbf,
		int	a_rbf,
		int	a_cbf,
		INTNB	a_voxel,
		int	a_th
	)

virtual

Implementation of the pure virtual vPenalty::ComputeSecondDerivative()

Parameters

int	a_tbf
int	a_rbf
int	a_cbf
INTNB	a_voxel
int	a_th

This function computes the second derivative of the penalty. It is the implementation of the pure virtual vPenalty::ComputeSecondDerivative().

Returns: The derivative

Implements vPenalty.

Definition at line 177 of file iPenaltyTemplate.cc.

◆ InitializeSpecific()

int iPenaltyTemplate::InitializeSpecific ( )

privatevirtual

This function is used to initialize specific stuff to the child penalty.

It is called by the public Initialize() function from the mother.

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

Implements vPenalty.

Definition at line 129 of file iPenaltyTemplate.cc.

◆ ReadConfigurationFile()

int iPenaltyTemplate::ReadConfigurationFile ( const string & a_configurationFile )

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 the child penalty, from a configuration file. It is the implementation of the pure virtual function inherited from the abstract class vPenalty. 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 vPenalty.

Definition at line 83 of file iPenaltyTemplate.cc.

◆ ReadOptionsList()

int iPenaltyTemplate::ReadOptionsList ( const string & a_optionsList )

virtual

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

Parameters

const string& a_optionsList

This function implements the reading of all options associated to the child penalty, from a list of options. It is the implementation of the pure virtual function inherited from the abstract class vPenalty. 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 vPenalty.

Definition at line 99 of file iPenaltyTemplate.cc.

◆ ShowHelpSpecific()

void iPenaltyTemplate::ShowHelpSpecific ( )

privatevirtual

A function used to show help about the child penalty.

This function must describe what the module does and how to use it. It describes in details the different parameters of the penalty, 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 vPenalty. It is called by the public ShowHelp() function.

Implements vPenalty.

Definition at line 72 of file iPenaltyTemplate.cc.

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ iPenaltyTemplate()

◆ ~iPenaltyTemplate()

Member Function Documentation

◆ CheckSpecificParameters()

◆ ComputeFirstDerivative()

◆ ComputePenaltyValue()

◆ ComputeSecondDerivative()

◆ InitializeSpecific()

◆ ReadConfigurationFile()

◆ ReadOptionsList()

◆ ShowHelpSpecific()