cmtk::ImageSymmetryPlaneFunctionalBase Class Reference [cmtkRegistration Library]

Base class for functionals to find a symmetry plane in 3-D volumes. More...

#include <cmtkImageSymmetryPlaneFunctionalBase.h>

Inheritance diagram for cmtk::ImageSymmetryPlaneFunctionalBase:

Collaboration diagram for cmtk::ImageSymmetryPlaneFunctionalBase:

List of all members.

Public Types
typedef ImageSymmetryPlaneFunctionalBase	Self
	This class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer to this class.
typedef Functional	Superclass
	Superclass.
Public Member Functions
	ImageSymmetryPlaneFunctionalBase (UniformVolume::SmartConstPtr &volume)
	Constructor.
	ImageSymmetryPlaneFunctionalBase (UniformVolume::SmartConstPtr &volume, const Types::DataItemRange &valueRange)
	Constructor with value range limits.
virtual	~ImageSymmetryPlaneFunctionalBase ()
	Destructor.
virtual void	GetParamVector (CoordinateVector &v)
	Get parameter vector.
virtual Self::ReturnType	Evaluate ()=0
	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.
void	SetFixOffset (const bool fixOffset)
	Set fix offset flag.
Static Protected Member Functions
static UniformVolume::SmartPtr	ApplyThresholds (const UniformVolume &volume, const Types::DataItemRange &valueRange)
	Apply thresholding to volume data.
Protected Attributes
UniformVolume::SmartConstPtr	m_Volume
	Volume image.
ParametricPlane	m_ParametricPlane
	The symmetry plane.
bool	m_FixOffset
	Flag for fixing offset parameter: resulting plane will go through volume center of mass.

---

Detailed Description

Base class for functionals to find a symmetry plane in 3-D volumes.

This class provides the interface and code that is independent of how the symmetry plane is computed.

Definition at line 53 of file cmtkImageSymmetryPlaneFunctionalBase.h.

---

Member Typedef Documentation

typedef ImageSymmetryPlaneFunctionalBase cmtk::ImageSymmetryPlaneFunctionalBase::Self

This class.

Reimplemented from cmtk::Functional.

Reimplemented in cmtk::ImageSymmetryPlaneFunctionalDevice, and cmtk::ImageSymmetryPlaneFunctional.

Definition at line 59 of file cmtkImageSymmetryPlaneFunctionalBase.h.

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

Smart pointer to this class.

Reimplemented from cmtk::Functional.

Reimplemented in cmtk::ImageSymmetryPlaneFunctionalDevice, and cmtk::ImageSymmetryPlaneFunctional.

Definition at line 62 of file cmtkImageSymmetryPlaneFunctionalBase.h.

typedef Functional cmtk::ImageSymmetryPlaneFunctionalBase::Superclass

Superclass.

Reimplemented in cmtk::ImageSymmetryPlaneFunctionalDevice, and cmtk::ImageSymmetryPlaneFunctional.

Definition at line 65 of file cmtkImageSymmetryPlaneFunctionalBase.h.

---

Constructor & Destructor Documentation

virtual cmtk::ImageSymmetryPlaneFunctionalBase::~ImageSymmetryPlaneFunctionalBase

(

)

[inline, virtual]

Destructor.

Definition at line 74 of file cmtkImageSymmetryPlaneFunctionalBase.h.

---

Member Function Documentation

virtual Self::ReturnType cmtk::ImageSymmetryPlaneFunctionalBase::Evaluate

(

)

[pure virtual]

Compute functional value.

Reimplemented from cmtk::Functional.

Implemented in cmtk::ImageSymmetryPlaneFunctionalDevice, and cmtk::ImageSymmetryPlaneFunctional.

virtual Self::ReturnType cmtk::ImageSymmetryPlaneFunctionalBase::EvaluateAt

(

CoordinateVector &

v )

[inline, virtual]

Compute functional value.

Definition at line 86 of file cmtkImageSymmetryPlaneFunctionalBase.h.

virtual void cmtk::ImageSymmetryPlaneFunctionalBase::GetParamVector

(

CoordinateVector &

v )

[inline, virtual]

Get parameter vector.

Definition at line 77 of file cmtkImageSymmetryPlaneFunctionalBase.h.

virtual size_t cmtk::ImageSymmetryPlaneFunctionalBase::ParamVectorDim

(

)

const [inline, virtual]

Return the symmetry plane's parameter vector dimension.

Implements cmtk::Functional.

Definition at line 93 of file cmtkImageSymmetryPlaneFunctionalBase.h.

void cmtk::ImageSymmetryPlaneFunctionalBase::SetFixOffset

(

const bool

fixOffset )

[inline]

Set fix offset flag.

Definition at line 102 of file cmtkImageSymmetryPlaneFunctionalBase.h.

virtual size_t cmtk::ImageSymmetryPlaneFunctionalBase::VariableParamVectorDim

(

)

const [inline, virtual]

Return the number of variable parameters of the transformation.

Reimplemented from cmtk::Functional.

Definition at line 96 of file cmtkImageSymmetryPlaneFunctionalBase.h.

---

Member Data Documentation

bool cmtk::ImageSymmetryPlaneFunctionalBase::m_FixOffset [protected]

Flag for fixing offset parameter: resulting plane will go through volume center of mass.

Definition at line 115 of file cmtkImageSymmetryPlaneFunctionalBase.h.

ParametricPlane cmtk::ImageSymmetryPlaneFunctionalBase::m_ParametricPlane [protected]

The symmetry plane.

Definition at line 112 of file cmtkImageSymmetryPlaneFunctionalBase.h.

UniformVolume::SmartConstPtr cmtk::ImageSymmetryPlaneFunctionalBase::m_Volume [protected]

Volume image.

Definition at line 109 of file cmtkImageSymmetryPlaneFunctionalBase.h.

---

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

• libs/Registration/cmtkImageSymmetryPlaneFunctionalBase.h
• libs/Registration/cmtkImageSymmetryPlaneFunctionalBase.cxx