cmtk::MultiChannelRegistrationFunctionalBase Class Reference [cmtkRegistration Library]

Base class for multi-channel registration functionals. More...

#include <cmtkMultiChannelRegistrationFunctionalBase.h>

Inheritance diagram for cmtk::MultiChannelRegistrationFunctionalBase:

Collaboration diagram for cmtk::MultiChannelRegistrationFunctionalBase:

List of all members.

Public Types
typedef MultiChannelRegistrationFunctionalBase	Self
	This class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer.
typedef Functional	Superclass
	Superclass.
Public Member Functions
	MultiChannelRegistrationFunctionalBase ()
	Default constructor.
virtual	~MultiChannelRegistrationFunctionalBase ()
	Destructor: free all converted image arrays.
void	SetNormalizedMI (const bool nmi=true)
	Set flag for normalized vs.
virtual void	ClearAllChannels ()
	Reset channels, clear all images.
virtual void	AddReferenceChannel (UniformVolume::SmartPtr &channel)
	Add reference channel.
template<class ForwardIterator >
void	AddReferenceChannels (ForwardIterator first, ForwardIterator last)
	Add reference channels from stl container.
size_t	GetNumberOfReferenceChannels () const
	Get number of reference channels.
UniformVolume::SmartPtr &	GetReferenceChannel (const size_t idx)
	Get a reference channel image.
const UniformVolume *	GetReferenceChannel (const size_t idx) const
	Get constant pointer to reference channel image.
virtual void	AddFloatingChannel (UniformVolume::SmartPtr &channel)
	Add floating channel.
template<class ForwardIterator >
void	AddFloatingChannels (ForwardIterator first, ForwardIterator last)
	Add floating channels from stl container.
size_t	GetNumberOfFloatingChannels () const
	Get number of floating channels.
UniformVolume::SmartPtr &	GetFloatingChannel (const size_t idx)
	Get a floating channel image.
const UniformVolume *	GetFloatingChannel (const size_t idx) const
	Get constant pointer to floating channel image.
Public Attributes
std::vector < UniformVolume::SmartPtr >	m_ReferenceChannels
	Vector of reference images.
std::vector < UniformVolume::SmartPtr >	m_FloatingChannels
	Vector of floating images.
Protected Member Functions
virtual void	NewReferenceChannelGeometry ()
	Update all transformation-related data after init or refine.
Protected Attributes
size_t	m_NumberOfChannels
	Total number of channels.
DataGrid::IndexType	m_ReferenceDims
	Grid dimensions of the reference volume.
UniformVolume::CoordinateVectorType	m_ReferenceSize
	Extents of the reference volume in real-world coordinates.
UniformVolume::CoordinateVectorType	m_ReferenceInvDelta
	Inverse pixel deltas of the reference volume.
DataGrid::RegionType	m_ReferenceCropRegion
	Rectangular crop region in the reference volume.
DataGrid::IndexType	m_FloatingDims
	Grid dimensions of the floating volume.
UniformVolume::CoordinateVectorType	m_FloatingSize
	Extents of the floating volume in real-world coordinates.
UniformVolume::CoordinateVectorType	m_FloatingInverseDelta
	Inverse pixel deltas of the floating volume.
UniformVolume::CoordinateRegionType	m_FloatingCropRegion
	Coordinates of the floating image cropping region.
bool	m_NormalizedMI
	Flag for normalized vs.
Private Member Functions
void	VerifyImageSize (const UniformVolume *imgA, const UniformVolume *imgB)
	Verify size and geometry of newly added image channels against already added channels.

---

Detailed Description

Base class for multi-channel registration functionals.

Definition at line 56 of file cmtkMultiChannelRegistrationFunctionalBase.h.

---

Member Typedef Documentation

typedef MultiChannelRegistrationFunctionalBase cmtk::MultiChannelRegistrationFunctionalBase::Self

This class.

Reimplemented from cmtk::Functional.

Reimplemented in cmtk::MultiChannelHistogramRegistrationFunctional< TDataType, TInterpolator, THashKeyType, NBitsPerChannel >, cmtk::MultiChannelRegistrationFunctional< TInterpolator >, and cmtk::MultiChannelRMIRegistrationFunctional< TRealType, TDataType, TInterpolator >.

Definition at line 62 of file cmtkMultiChannelRegistrationFunctionalBase.h.

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

Smart pointer.

Reimplemented from cmtk::Functional.

Reimplemented in cmtk::MultiChannelHistogramRegistrationFunctional< TDataType, TInterpolator, THashKeyType, NBitsPerChannel >, cmtk::MultiChannelRegistrationFunctional< TInterpolator >, and cmtk::MultiChannelRMIRegistrationFunctional< TRealType, TDataType, TInterpolator >.

Definition at line 65 of file cmtkMultiChannelRegistrationFunctionalBase.h.

typedef Functional cmtk::MultiChannelRegistrationFunctionalBase::Superclass

Superclass.

Reimplemented in cmtk::MultiChannelHistogramRegistrationFunctional< TDataType, TInterpolator, THashKeyType, NBitsPerChannel >, cmtk::MultiChannelRegistrationFunctional< TInterpolator >, and cmtk::MultiChannelRMIRegistrationFunctional< TRealType, TDataType, TInterpolator >.

Definition at line 68 of file cmtkMultiChannelRegistrationFunctionalBase.h.

---

Constructor & Destructor Documentation

cmtk::MultiChannelRegistrationFunctionalBase::MultiChannelRegistrationFunctionalBase

(

)

[inline]

Default constructor.

Definition at line 71 of file cmtkMultiChannelRegistrationFunctionalBase.h.

virtual cmtk::MultiChannelRegistrationFunctionalBase::~MultiChannelRegistrationFunctionalBase

(

)

[inline, virtual]

Destructor: free all converted image arrays.

Definition at line 74 of file cmtkMultiChannelRegistrationFunctionalBase.h.

---

Member Function Documentation

template<class ForwardIterator >

void cmtk::MultiChannelRegistrationFunctionalBase::AddFloatingChannels	(	ForwardIterator	first,
		ForwardIterator	last
	)		[inline]

Add floating channels from stl container.

Definition at line 116 of file cmtkMultiChannelRegistrationFunctionalBase.h.

template<class ForwardIterator >

void cmtk::MultiChannelRegistrationFunctionalBase::AddReferenceChannels	(	ForwardIterator	first,
		ForwardIterator	last
	)		[inline]

Add reference channels from stl container.

Definition at line 93 of file cmtkMultiChannelRegistrationFunctionalBase.h.

UniformVolume::SmartPtr& cmtk::MultiChannelRegistrationFunctionalBase::GetFloatingChannel

(

const size_t

idx )

[inline]

Get a floating channel image.

Definition at line 129 of file cmtkMultiChannelRegistrationFunctionalBase.h.

const UniformVolume* cmtk::MultiChannelRegistrationFunctionalBase::GetFloatingChannel

(

const size_t

idx )

const [inline]

Get constant pointer to floating channel image.

Definition at line 132 of file cmtkMultiChannelRegistrationFunctionalBase.h.

size_t cmtk::MultiChannelRegistrationFunctionalBase::GetNumberOfFloatingChannels

(

)

const [inline]

Get number of floating channels.

Definition at line 126 of file cmtkMultiChannelRegistrationFunctionalBase.h.

size_t cmtk::MultiChannelRegistrationFunctionalBase::GetNumberOfReferenceChannels

(

)

const [inline]

Get number of reference channels.

Definition at line 103 of file cmtkMultiChannelRegistrationFunctionalBase.h.

const UniformVolume* cmtk::MultiChannelRegistrationFunctionalBase::GetReferenceChannel

(

const size_t

idx )

const [inline]

Get constant pointer to reference channel image.

Definition at line 109 of file cmtkMultiChannelRegistrationFunctionalBase.h.

UniformVolume::SmartPtr& cmtk::MultiChannelRegistrationFunctionalBase::GetReferenceChannel

(

const size_t

idx )

[inline]

Get a reference channel image.

Definition at line 106 of file cmtkMultiChannelRegistrationFunctionalBase.h.

virtual void cmtk::MultiChannelRegistrationFunctionalBase::NewReferenceChannelGeometry

(

)

[inline, protected, virtual]

Update all transformation-related data after init or refine.

Definition at line 169 of file cmtkMultiChannelRegistrationFunctionalBase.h.

void cmtk::MultiChannelRegistrationFunctionalBase::SetNormalizedMI

(

const bool

nmi = true )

[inline]

Set flag for normalized vs.

standard MI

Definition at line 80 of file cmtkMultiChannelRegistrationFunctionalBase.h.

---

Member Data Documentation

std::vector<UniformVolume::SmartPtr> cmtk::MultiChannelRegistrationFunctionalBase::m_FloatingChannels

Vector of floating images.

Definition at line 138 of file cmtkMultiChannelRegistrationFunctionalBase.h.

Referenced by cmtk::MultiChannelRMIRegistrationFunctional< TRealType, TDataType, TInterpolator >::MetricData::Init().

UniformVolume::CoordinateRegionType cmtk::MultiChannelRegistrationFunctionalBase::m_FloatingCropRegion [protected]

Coordinates of the floating image cropping region.

Definition at line 166 of file cmtkMultiChannelRegistrationFunctionalBase.h.

DataGrid::IndexType cmtk::MultiChannelRegistrationFunctionalBase::m_FloatingDims [protected]

Grid dimensions of the floating volume.

Definition at line 157 of file cmtkMultiChannelRegistrationFunctionalBase.h.

UniformVolume::CoordinateVectorType cmtk::MultiChannelRegistrationFunctionalBase::m_FloatingInverseDelta [protected]

Inverse pixel deltas of the floating volume.

Definition at line 163 of file cmtkMultiChannelRegistrationFunctionalBase.h.

UniformVolume::CoordinateVectorType cmtk::MultiChannelRegistrationFunctionalBase::m_FloatingSize [protected]

Extents of the floating volume in real-world coordinates.

Definition at line 160 of file cmtkMultiChannelRegistrationFunctionalBase.h.

bool cmtk::MultiChannelRegistrationFunctionalBase::m_NormalizedMI [protected]

Flag for normalized vs.

standard mutual information.

Definition at line 173 of file cmtkMultiChannelRegistrationFunctionalBase.h.

size_t cmtk::MultiChannelRegistrationFunctionalBase::m_NumberOfChannels [protected]

Total number of channels.

This is the sum of the floating and reference channel vector sizes.

Definition at line 142 of file cmtkMultiChannelRegistrationFunctionalBase.h.

std::vector<UniformVolume::SmartPtr> cmtk::MultiChannelRegistrationFunctionalBase::m_ReferenceChannels

Vector of reference images.

Definition at line 135 of file cmtkMultiChannelRegistrationFunctionalBase.h.

Referenced by cmtk::MultiChannelRMIRegistrationFunctional< TRealType, TDataType, TInterpolator >::MetricData::Init().

DataGrid::RegionType cmtk::MultiChannelRegistrationFunctionalBase::m_ReferenceCropRegion [protected]

Rectangular crop region in the reference volume.

Definition at line 154 of file cmtkMultiChannelRegistrationFunctionalBase.h.

DataGrid::IndexType cmtk::MultiChannelRegistrationFunctionalBase::m_ReferenceDims [protected]

Grid dimensions of the reference volume.

Definition at line 145 of file cmtkMultiChannelRegistrationFunctionalBase.h.

UniformVolume::CoordinateVectorType cmtk::MultiChannelRegistrationFunctionalBase::m_ReferenceInvDelta [protected]

Inverse pixel deltas of the reference volume.

Definition at line 151 of file cmtkMultiChannelRegistrationFunctionalBase.h.

UniformVolume::CoordinateVectorType cmtk::MultiChannelRegistrationFunctionalBase::m_ReferenceSize [protected]

Extents of the reference volume in real-world coordinates.

Definition at line 148 of file cmtkMultiChannelRegistrationFunctionalBase.h.

---

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

• libs/Registration/cmtkMultiChannelRegistrationFunctionalBase.h
• libs/Registration/cmtkMultiChannelRegistrationFunctionalBase.cxx