vPenalty Class Reference

This class is designed to generically described any penalty applied to MAP algorithms. More...

#include <vPenalty.hh>

Collaboration diagram for vPenalty:

Public Member Functions
	vPenalty ()
	The constructor of vPenalty. More...
virtual	~vPenalty ()
	The destructor of vPenalty. 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...

Protected Attributes
oImageDimensionsAndQuantification *	mp_ImageDimensionsAndQuantification
int	m_verbose

Detailed Description

This class is designed to generically described any penalty applied to MAP algorithms.

This class is an abstract one, in the sense that it cannot be used on its own because several pure virtual functions belong to it. Its children are implementations of actual penalties. Everywhere in the code, this parent class should be used instead of any of its children. Nothing is yet implemented. To be designed.

Definition at line 46 of file vPenalty.hh.

Constructor & Destructor Documentation

vPenalty::vPenalty

(

)

The constructor of vPenalty.

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 39 of file vPenalty.cc.

vPenalty::~vPenalty ( )

virtual

The destructor of vPenalty.

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. It is virtual, so that it is automatically called when a child object is deleted.

Definition at line 51 of file vPenalty.cc.

Member Function Documentation

public inline void vPenalty::SetImageDimensionsAndQuantification ( oImageDimensionsAndQuantification *  ap_ImageDimensionsAndQuantification )

inline

Set the pointer to the image dimensions in use.

Parameters

oImageDimensionsAndQuantification*

ap_ImageDimensionsAndQuantification

Definition at line 88 of file vPenalty.hh.

public inline void vPenalty::SetVerbose ( int  a_verbose )

inline

Set the verbose level.

Parameters

int	a_verboseLevel

Definition at line 81 of file vPenalty.hh.

Member Data Documentation

int vPenalty::m_verbose

protected

The verbose level

Definition at line 108 of file vPenalty.hh.

oImageDimensionsAndQuantification* vPenalty::mp_ImageDimensionsAndQuantification

protected

The pointer to the image dimensions and quantification object

Definition at line 106 of file vPenalty.hh.

---

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

• vPenalty.hh
• vPenalty.cc