cmtk::FunctionalAffine2D Class Reference [cmtkRegistration Library]

Functional for the affine registration two 2D images. More...

#include <cmtkFunctionalAffine2D.h>

Inheritance diagram for cmtk::FunctionalAffine2D:

Collaboration diagram for cmtk::FunctionalAffine2D:

List of all members.

Public Types
typedef FunctionalAffine2D	Self
	This class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer.
typedef Functional	Superclass
	Parent class.
Public Member Functions
	FunctionalAffine2D (ScalarImage::SmartPtr &refImage, ScalarImage::SmartPtr &fltImage, const ScalarImage::RegionType *fltROI=NULL)
	Contructor.
	FunctionalAffine2D (std::vector< ScalarImage::SmartPtr > &refImage, std::vector< ScalarImage::SmartPtr > &fltImage, const ScalarImage::RegionType *fltROI=NULL)
	Contructor.
	~FunctionalAffine2D ()
	Virtual destructor (dummy).
virtual void	SetRefImage (ScalarImage::SmartPtr &refImage)
	Set reference image.
virtual void	SetRefImages (std::vector< ScalarImage::SmartPtr > &refImages)
	Set reference image.
virtual void	SetFltImage (ScalarImage::SmartPtr &fltImage)
	Set floating image (and floating image ROI).
virtual void	SetFltImages (std::vector< ScalarImage::SmartPtr > &fltImages)
	Set floating image (and floating image ROI).
void	SetNumberOfBins (const size_t minBins, const size_t maxBins=0)
	Set minimum and maximum number of bins for histogram-based similarity.
virtual Self::ReturnType	Evaluate ()
	Compute functional value.
virtual Self::ReturnType	EvaluateAt (CoordinateVector &v)
	Compute functional value.
virtual Self::ReturnType	EvaluateWithGradient (CoordinateVector &, CoordinateVector &, const Types::Coordinate=1)
	Compute functional value and gradient.
virtual void	SetParamVector (CoordinateVector &v)
	Set parameter vector without evaluating the functional.
virtual void	GetParamVector (CoordinateVector &v)
	Return current parameter vector.
virtual size_t	ParamVectorDim () const
	Return the transformation'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 parameter stepping.
Private Member Functions
	cmtkGetSetMacro (int, NumberDOFs)
	Number of degrees of freedom.
	cmtkGetSetMacro (ScalarImageSimilarity::ID, SimilarityMeasure)
	Similarity metric.
	cmtkGetSetMacro (bool, HistogramEqualization)
	Flag for histogram equalization of projection data.
Self::ReturnType	GetSimilarity (const ScalarImage *img0, const ScalarImage *img1) const
	Compute appropriate similarity measure for a single image pair.
Self::ReturnType	GetSimilarity (std::vector< const ScalarImage * > &imgs0, std::vector< const ScalarImage * > &imgs1) const
	Compute appropriate similarity measure for multiple images.
Private Attributes
std::vector < ScalarImage::SmartPtr >	RefImages
	Reference image.
std::vector < ScalarImage::SmartPtr >	FltImages
	Floating image.
std::vector < ScalarImage::SmartPtr >	FltImagesROI
	ROI from floating image.
ScalarImageSimilarityMemory	ImageSimilarityMemory
	Persistent image similarity object.
CoordinateVector	Parameters
	Parameter vector.
CoordinateMatrix3x3	Transformation
	Transformation.

---

Detailed Description

Functional for the affine registration two 2D images.

Definition at line 60 of file cmtkFunctionalAffine2D.h.

---

Member Typedef Documentation

typedef FunctionalAffine2D cmtk::FunctionalAffine2D::Self

This class.

Reimplemented from cmtk::Functional.

Definition at line 75 of file cmtkFunctionalAffine2D.h.

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

Smart pointer.

Reimplemented from cmtk::Functional.

Definition at line 78 of file cmtkFunctionalAffine2D.h.

typedef Functional cmtk::FunctionalAffine2D::Superclass

Parent class.

Definition at line 81 of file cmtkFunctionalAffine2D.h.

---

Constructor & Destructor Documentation

cmtk::FunctionalAffine2D::~FunctionalAffine2D

(

)

[inline]

Virtual destructor (dummy).

Definition at line 90 of file cmtkFunctionalAffine2D.h.

---

Member Function Documentation

cmtk::FunctionalAffine2D::cmtkGetSetMacro	(	int	,
		NumberDOFs
	)		[private]

Number of degrees of freedom.

cmtk::FunctionalAffine2D::cmtkGetSetMacro	(	ScalarImageSimilarity::ID	,
		SimilarityMeasure
	)		[private]

Similarity metric.

cmtk::FunctionalAffine2D::cmtkGetSetMacro	(	bool	,
		HistogramEqualization
	)		[private]

Flag for histogram equalization of projection data.

virtual Self::ReturnType cmtk::FunctionalAffine2D::EvaluateWithGradient	(	CoordinateVector &	,
		CoordinateVector &	,
		const Types::Coordinate	= 1
	)		[inline, virtual]

Compute functional value and gradient.

Definition at line 133 of file cmtkFunctionalAffine2D.h.

virtual size_t cmtk::FunctionalAffine2D::ParamVectorDim

(

)

const [inline, virtual]

Return the transformation's parameter vector dimension.

Implements cmtk::Functional.

Definition at line 147 of file cmtkFunctionalAffine2D.h.

virtual void cmtk::FunctionalAffine2D::SetFltImage

(

ScalarImage::SmartPtr &

fltImage )

[inline, virtual]

Set floating image (and floating image ROI).

Definition at line 107 of file cmtkFunctionalAffine2D.h.

virtual void cmtk::FunctionalAffine2D::SetFltImages

(

std::vector< ScalarImage::SmartPtr > &

fltImages )

[inline, virtual]

Set floating image (and floating image ROI).

Definition at line 117 of file cmtkFunctionalAffine2D.h.

virtual void cmtk::FunctionalAffine2D::SetRefImage

(

ScalarImage::SmartPtr &

refImage )

[inline, virtual]

Set reference image.

Definition at line 93 of file cmtkFunctionalAffine2D.h.

virtual void cmtk::FunctionalAffine2D::SetRefImages

(

std::vector< ScalarImage::SmartPtr > &

refImages )

[inline, virtual]

Set reference image.

Definition at line 101 of file cmtkFunctionalAffine2D.h.

virtual size_t cmtk::FunctionalAffine2D::VariableParamVectorDim

(

)

const [inline, virtual]

Return the number of variable parameters of the transformation.

Reimplemented from cmtk::Functional.

Definition at line 150 of file cmtkFunctionalAffine2D.h.

---

Member Data Documentation

std::vector<ScalarImage::SmartPtr> cmtk::FunctionalAffine2D::FltImages [private]

Floating image.

Definition at line 160 of file cmtkFunctionalAffine2D.h.

std::vector<ScalarImage::SmartPtr> cmtk::FunctionalAffine2D::FltImagesROI [private]

ROI from floating image.

If the constructor is called without ROI, this is the same object as FltImage.

Definition at line 166 of file cmtkFunctionalAffine2D.h.

ScalarImageSimilarityMemory cmtk::FunctionalAffine2D::ImageSimilarityMemory [mutable, private]

Persistent image similarity object.

Definition at line 169 of file cmtkFunctionalAffine2D.h.

CoordinateVector cmtk::FunctionalAffine2D::Parameters [private]

Parameter vector.

Definition at line 178 of file cmtkFunctionalAffine2D.h.

std::vector<ScalarImage::SmartPtr> cmtk::FunctionalAffine2D::RefImages [private]

Reference image.

Definition at line 157 of file cmtkFunctionalAffine2D.h.

CoordinateMatrix3x3 cmtk::FunctionalAffine2D::Transformation [private]

Transformation.

Definition at line 181 of file cmtkFunctionalAffine2D.h.

---

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

• libs/Registration/cmtkFunctionalAffine2D.h
• libs/Registration/cmtkFunctionalAffine2D.cxx