cmtk::SymmetryPlaneFunctional Class Reference [cmtkRegistration Library]

Functional for finding a symmetry plane in 3-D volumes. More...

#include <cmtkSymmetryPlaneFunctional.h>

Inheritance diagram for cmtk::SymmetryPlaneFunctional:

Collaboration diagram for cmtk::SymmetryPlaneFunctional:

List of all members.

Public Types
typedef SymmetryPlaneFunctional	Self
	This class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer to this class.
typedef Functional	Superclass
	Superclass.
Public Member Functions
	SymmetryPlaneFunctional (UniformVolume::SmartPtr &volume)
	Constructor.
	SymmetryPlaneFunctional (UniformVolume::SmartPtr &volume, const Types::DataItemRange &valueRange)
	Constructor with value range limits.
virtual	~SymmetryPlaneFunctional ()
	Destructor.
void	SetVolume (UniformVolume::SmartPtr &volume)
	Set volume.
virtual void	GetParamVector (CoordinateVector &v)
virtual Self::ReturnType	Evaluate ()
	Compute functional value.
virtual Self::ReturnType	EvaluateAt (CoordinateVector &v)
	Compute functional value.
virtual size_t	ParamVectorDim () const
	Return the symmetry plane's parameter vector dimension.
virtual size_t	VariableParamVectorDim () const
	Return the number of variable parameters of the transformation.
virtual Types::Coordinate	GetParamStep (const size_t idx, const Types::Coordinate mmStep=1) const
	Return the parameter stepping for 1 mm optimization steps.
Protected Attributes
UniformVolume::SmartPtr	m_Volume
	Volume image.
Private Attributes
VoxelMatchingNormMutInf *	m_Metric
	Image similarity measure.
ParametricPlane	m_ParametricPlane
	The symmetry plane.

---

Detailed Description

Functional for finding a symmetry plane in 3-D volumes.

Definition at line 53 of file cmtkSymmetryPlaneFunctional.h.

---

Member Typedef Documentation

typedef SymmetryPlaneFunctional cmtk::SymmetryPlaneFunctional::Self

This class.

Reimplemented from cmtk::Functional.

Definition at line 63 of file cmtkSymmetryPlaneFunctional.h.

typedef SmartPointer<Self> cmtk::SymmetryPlaneFunctional::SmartPtr

Smart pointer to this class.

Reimplemented from cmtk::Functional.

Definition at line 66 of file cmtkSymmetryPlaneFunctional.h.

typedef Functional cmtk::SymmetryPlaneFunctional::Superclass

Superclass.

Definition at line 69 of file cmtkSymmetryPlaneFunctional.h.

---

Constructor & Destructor Documentation

virtual cmtk::SymmetryPlaneFunctional::~SymmetryPlaneFunctional

(

)

[inline, virtual]

Destructor.

Definition at line 78 of file cmtkSymmetryPlaneFunctional.h.

---

Member Function Documentation

virtual Self::ReturnType cmtk::SymmetryPlaneFunctional::EvaluateAt

(

CoordinateVector &

v )

[inline, virtual]

Compute functional value.

Definition at line 95 of file cmtkSymmetryPlaneFunctional.h.

virtual void cmtk::SymmetryPlaneFunctional::GetParamVector

(

CoordinateVector &

v )

[inline, virtual]

Definition at line 86 of file cmtkSymmetryPlaneFunctional.h.

virtual size_t cmtk::SymmetryPlaneFunctional::ParamVectorDim

(

)

const [inline, virtual]

Return the symmetry plane's parameter vector dimension.

Implements cmtk::Functional.

Definition at line 102 of file cmtkSymmetryPlaneFunctional.h.

void cmtk::SymmetryPlaneFunctional::SetVolume

(

UniformVolume::SmartPtr &

volume )

[inline]

Set volume.

Definition at line 81 of file cmtkSymmetryPlaneFunctional.h.

virtual size_t cmtk::SymmetryPlaneFunctional::VariableParamVectorDim

(

)

const [inline, virtual]

Return the number of variable parameters of the transformation.

Reimplemented from cmtk::Functional.

Definition at line 105 of file cmtkSymmetryPlaneFunctional.h.

---

Member Data Documentation

VoxelMatchingNormMutInf* cmtk::SymmetryPlaneFunctional::m_Metric [private]

Image similarity measure.

Definition at line 112 of file cmtkSymmetryPlaneFunctional.h.

ParametricPlane cmtk::SymmetryPlaneFunctional::m_ParametricPlane [private]

The symmetry plane.

Definition at line 115 of file cmtkSymmetryPlaneFunctional.h.

UniformVolume::SmartPtr cmtk::SymmetryPlaneFunctional::m_Volume [protected]

Volume image.

Definition at line 59 of file cmtkSymmetryPlaneFunctional.h.

---

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

• libs/Registration/cmtkSymmetryPlaneFunctional.h
• libs/Registration/cmtkSymmetryPlaneFunctional.cxx