This class implements the "median root prior". More...

#include <iPenaltyMedianRootPrior.hh>

Inheritance diagram for iPenaltyMedianRootPrior:

Collaboration diagram for iPenaltyMedianRootPrior:

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

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

int	ReadConfigurationFile (const string &a_configurationFile)

int	ReadOptionsList (const string &a_optionsList)

int	LocalPreProcessingStep (int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)

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

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

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

	iPenaltyMedianRootPrior ()

	~iPenaltyMedianRootPrior ()

int	ReadConfigurationFile (const string &a_configurationFile)

int	ReadOptionsList (const string &a_optionsList)

int	LocalPreProcessingStep (int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)

FLTNB	ComputePenaltyValue (FLTNB *ap_image, INTNB a_voxel, int a_th)

FLTNB	ComputeFirstDerivative (FLTNB *ap_image, INTNB a_voxel, int a_th)

FLTNB	ComputeSecondDerivative (FLTNB *ap_image, INTNB a_voxel, int a_th)

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...

void	SetVerbose (int a_verbose)

void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)

void	SetImageSpace (oImageSpace *ap_ImageSpace)

void	SetPenaltyStrength (FLTNB a_penaltyStrength)

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

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

void	SetPenaltyID (const string &a_penaltyID)

const string &	GetPenaltyID ()

	vPenalty ()

virtual	~vPenalty ()

void	ShowHelp ()

int	CheckParameters ()

int	Initialize ()

virtual int	GlobalPreProcessingStep ()

void	SetVerbose (int a_verbose)

void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)

void	SetImageSpace (oImageSpace *ap_ImageSpace)

void	SetDataFile (vDataFile *ap_DataFile)
	Set the image space in use. More...

void	SetPenaltyStrength (FLTNB a_penaltyStrength)

FLTNB	GetPenaltyStrength ()

int	GetPenaltyDerivativesOrder ()

void	SetPenaltyID (const string &a_penaltyID)

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...

int	BuildNeighborhoodKernel ()
	A function used to build the neighborhood kernel. More...

int	BuildSpecificNeighborhood (INTNB a_voxel, int a_th)

int	ComputeMedianInNeighborhood (int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)

void	ShowHelpSpecific ()
	A function used to show help about the child module. More...

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

int	InitializeSpecific ()
	A private function used to initialize everything specific to the child penalty. More...

int	BuildNeighborhoodKernel ()

int	BuildSpecificNeighborhood (INTNB a_voxel, int a_th)

int	ComputeMedianInNeighborhood (int a_tbf, int a_rbf, int a_cbf, INTNB a_voxel, int a_th)

Private Attributes
int	m_neighborhoodShape

FLTNB	m_neighborhoodSphereRadius

int	m_neighborhoodBoxOrder

int	m_neighborhoodBoxExcludeCorners

INTNB	m_neighborhoodMaxNbVoxels

INTNB **	m2p_neighborhoodKernel

INTNB *	mp_neighborhoodNbVoxels

INTNB **	m2p_neighborhoodIndices

FLTNB *	mp_medianValue

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

vDataFile *	mp_DataFile

Detailed Description

This class implements the "median root prior".

This class inherits from vPenalty and implements the "median root prior".

Definition at line 30 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

Constructor & Destructor Documentation

◆ iPenaltyMedianRootPrior() [1/2]

iPenaltyMedianRootPrior::iPenaltyMedianRootPrior ( )

The constructor of iPenaltyMedianRootPrior.

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 15 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

◆ ~iPenaltyMedianRootPrior() [1/2]

iPenaltyMedianRootPrior::~iPenaltyMedianRootPrior ( )

The destructor of iPenaltyMedianRootPrior.

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 38 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

Here is the call graph for this function:

◆ iPenaltyMedianRootPrior() [2/2]

iPenaltyMedianRootPrior::iPenaltyMedianRootPrior ( )

◆ ~iPenaltyMedianRootPrior() [2/2]

iPenaltyMedianRootPrior::~iPenaltyMedianRootPrior ( )

Member Function Documentation

◆ BuildNeighborhoodKernel() [1/2]

int iPenaltyMedianRootPrior::BuildNeighborhoodKernel ( )

private

◆ BuildNeighborhoodKernel() [2/2]

int iPenaltyMedianRootPrior::BuildNeighborhoodKernel ( )

private

A function used to build the neighborhood kernel.

This function build the table m2p_neighborhoodKernel, that prepare neighborhood indices operations. It is called only one time at initialization. The kernel will be used when computing the specific neighborhood of any voxel later on.

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

Definition at line 255 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildSpecificNeighborhood() [1/2]

int iPenaltyMedianRootPrior::BuildSpecificNeighborhood	(	INTNB	a_voxel,
		int	a_th
	)

private

◆ BuildSpecificNeighborhood() [2/2]

int iPenaltyMedianRootPrior::BuildSpecificNeighborhood	(	INTNB	a_voxel,
		int	a_th
	)

private

Definition at line 388 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckSpecificParameters() [1/2]

int iPenaltyMedianRootPrior::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. It is pure virtual so is implemented by children.

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

Implements vPenalty.

◆ CheckSpecificParameters() [2/2]

int iPenaltyMedianRootPrior::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 175 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

◆ ComputeFirstDerivative() [1/2]

FLTNB iPenaltyMedianRootPrior::ComputeFirstDerivative	(	FLTNB *	ap_image,
		INTNB	a_voxel,
		int	a_th
	)

virtual

Implements vPenalty.

Definition at line 506 of file src/optimizer/iPenaltyMedianRootPrior.cc.

◆ ComputeFirstDerivative() [2/2]

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

virtual

Implements vPenalty.

Definition at line 506 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

◆ ComputeMedianInNeighborhood() [1/2]

int iPenaltyMedianRootPrior::ComputeMedianInNeighborhood	(	int	a_tbf,
		int	a_rbf,
		int	a_cbf,
		INTNB	a_voxel,
		int	a_th
	)

private

◆ ComputeMedianInNeighborhood() [2/2]

int iPenaltyMedianRootPrior::ComputeMedianInNeighborhood	(	int	a_tbf,
		int	a_rbf,
		int	a_cbf,
		INTNB	a_voxel,
		int	a_th
	)

private

Definition at line 455 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

Here is the caller graph for this function:

◆ ComputePenaltyValue() [1/2]

FLTNB iPenaltyMedianRootPrior::ComputePenaltyValue	(	FLTNB *	ap_image,
		INTNB	a_voxel,
		int	a_th
	)

virtual

Implements vPenalty.

Definition at line 489 of file src/optimizer/iPenaltyMedianRootPrior.cc.

◆ ComputePenaltyValue() [2/2]

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

virtual

Implements vPenalty.

Definition at line 489 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

◆ ComputeSecondDerivative() [1/2]

FLTNB iPenaltyMedianRootPrior::ComputeSecondDerivative	(	FLTNB *	ap_image,
		INTNB	a_voxel,
		int	a_th
	)

virtual

Implements vPenalty.

Definition at line 521 of file src/optimizer/iPenaltyMedianRootPrior.cc.

◆ ComputeSecondDerivative() [2/2]

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

virtual

Implements vPenalty.

Definition at line 521 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

◆ InitializeSpecific() [1/2]

int iPenaltyMedianRootPrior::InitializeSpecific ( )

privatevirtual

A private function used to initialize everything specific to the child penalty.

This function is used to initialize everything specific to the penalty that should be initialized. It is called by the Initialize() function. It is pure virtual so is implemented by children.

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

Implements vPenalty.

◆ InitializeSpecific() [2/2]

int iPenaltyMedianRootPrior::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 203 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

Here is the call graph for this function:

◆ LocalPreProcessingStep() [1/2]

int iPenaltyMedianRootPrior::LocalPreProcessingStep	(	int	a_tbf,
		int	a_rbf,
		int	a_cbf,
		INTNB	a_voxel,
		int	a_th
	)

virtual

Reimplemented from vPenalty.

Definition at line 432 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

Here is the call graph for this function:

◆ LocalPreProcessingStep() [2/2]

int iPenaltyMedianRootPrior::LocalPreProcessingStep	(	int	a_tbf,
		int	a_rbf,
		int	a_cbf,
		INTNB	a_voxel,
		int	a_th
	)

virtual

Reimplemented from vPenalty.

◆ ReadConfigurationFile() [1/2]

int iPenaltyMedianRootPrior::ReadConfigurationFile ( const string & a_configurationFile )

virtual

Implements vPenalty.

Definition at line 97 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

Here is the call graph for this function:

◆ ReadConfigurationFile() [2/2]

int iPenaltyMedianRootPrior::ReadConfigurationFile ( const string & a_configurationFile )

virtual

Implements vPenalty.

◆ ReadOptionsList() [1/2]

int iPenaltyMedianRootPrior::ReadOptionsList ( const string & a_optionsList )

virtual

Implements vPenalty.

◆ ReadOptionsList() [2/2]

int iPenaltyMedianRootPrior::ReadOptionsList ( const string & a_optionsList )

virtual

Implements vPenalty.

Definition at line 163 of file code/src/optimizer/iPenaltyMedianRootPrior.cc.

◆ ShowHelpSpecific() [1/2]

void iPenaltyMedianRootPrior::ShowHelpSpecific ( )

privatevirtual

A function used to show help about the child module.

This function must describe what the penalty 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 pure virtual so is implemented by children. It is private because called by the public ShowHelp() function.

Implements vPenalty.

◆ ShowHelpSpecific() [2/2]

void iPenaltyMedianRootPrior::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 code/src/optimizer/iPenaltyMedianRootPrior.cc.

Member Data Documentation

◆ m2p_neighborhoodIndices

INTNB ** iPenaltyMedianRootPrior::m2p_neighborhoodIndices

private

Neighborhood indices of a specific voxel. First index is on the threads, second one contains the list of the voxels in the neighborhood (as many as m_neighborhoodMaxNbVoxels). It follows strictly the same order than m2p_neighborhoodKernel, with the convention -1: out of image boundaries

Definition at line 206 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

◆ m2p_neighborhoodKernel

INTNB ** iPenaltyMedianRootPrior::m2p_neighborhoodKernel

private

Neighborhood of a virtual voxel of coordinates 0, 0, 0 without boundary. First index on neighboring voxels, second one on indexes

Definition at line 204 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

◆ m_neighborhoodBoxExcludeCorners

int iPenaltyMedianRootPrior::m_neighborhoodBoxExcludeCorners

private

In case of a box neighborhood, remove the corners as in some papers, or not (keep them by default)

Definition at line 202 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

◆ m_neighborhoodBoxOrder

int iPenaltyMedianRootPrior::m_neighborhoodBoxOrder

private

In case of a box neighborhood, order of the box

Definition at line 201 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

◆ m_neighborhoodMaxNbVoxels

INTNB iPenaltyMedianRootPrior::m_neighborhoodMaxNbVoxels

private

Maximum number of voxels in the neighborhood

Definition at line 203 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

◆ m_neighborhoodShape

int iPenaltyMedianRootPrior::m_neighborhoodShape

private

Type of neighborhood (sphere, box)

Definition at line 199 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

◆ m_neighborhoodSphereRadius

FLTNB iPenaltyMedianRootPrior::m_neighborhoodSphereRadius

private

In case of a spherical neighborhood, radius of the sphere

Definition at line 200 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

◆ mp_medianValue

FLTNB * iPenaltyMedianRootPrior::mp_medianValue

private

Used to store the median value of the neighborhood, per thread

Definition at line 208 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

◆ mp_neighborhoodNbVoxels

INTNB * iPenaltyMedianRootPrior::mp_neighborhoodNbVoxels

private

Number of voxels in a specific neighborhood. The index is on threads

Definition at line 205 of file code/include/optimizer/iPenaltyMedianRootPrior.hh.

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ iPenaltyMedianRootPrior() [1/2]

◆ ~iPenaltyMedianRootPrior() [1/2]

◆ iPenaltyMedianRootPrior() [2/2]

◆ ~iPenaltyMedianRootPrior() [2/2]

Member Function Documentation

◆ BuildNeighborhoodKernel() [1/2]

◆ BuildNeighborhoodKernel() [2/2]

◆ BuildSpecificNeighborhood() [1/2]

◆ BuildSpecificNeighborhood() [2/2]

◆ CheckSpecificParameters() [1/2]

◆ CheckSpecificParameters() [2/2]

◆ ComputeFirstDerivative() [1/2]

◆ ComputeFirstDerivative() [2/2]

◆ ComputeMedianInNeighborhood() [1/2]

◆ ComputeMedianInNeighborhood() [2/2]

◆ ComputePenaltyValue() [1/2]

◆ ComputePenaltyValue() [2/2]

◆ ComputeSecondDerivative() [1/2]

◆ ComputeSecondDerivative() [2/2]

◆ InitializeSpecific() [1/2]

◆ InitializeSpecific() [2/2]

◆ LocalPreProcessingStep() [1/2]

◆ LocalPreProcessingStep() [2/2]

◆ ReadConfigurationFile() [1/2]

◆ ReadConfigurationFile() [2/2]

◆ ReadOptionsList() [1/2]

◆ ReadOptionsList() [2/2]

◆ ShowHelpSpecific() [1/2]

◆ ShowHelpSpecific() [2/2]

Member Data Documentation

◆ m2p_neighborhoodIndices

◆ m2p_neighborhoodKernel

◆ m_neighborhoodBoxExcludeCorners

◆ m_neighborhoodBoxOrder

◆ m_neighborhoodMaxNbVoxels

◆ m_neighborhoodShape

◆ m_neighborhoodSphereRadius

◆ mp_medianValue

◆ mp_neighborhoodNbVoxels