cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform > Class Template Reference [cmtkRegistration Library]

Base class template for groupwise registration functionals. More...

#include <cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h>

Inheritance diagram for cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >:

Collaboration diagram for cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >:

List of all members.

Public Types
typedef GroupwiseRegistrationFunctionalBase	Superclass
	Type of this class.
typedef GroupwiseRegistrationFunctionalXformTemplateBase < TXform >	Self
	Type of this class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer.
typedef TXform	XformType
	Transformation type.
typedef XformType::SmartPtr	XformPointer
	Smart pointer to transformation type.
Public Member Functions
	GroupwiseRegistrationFunctionalXformTemplateBase ()
	Constructor.
virtual	~GroupwiseRegistrationFunctionalXformTemplateBase ()
	Destructor.
virtual void	SetNumberOfHistogramBins (const size_t numberOfHistogramBins)
	Set number of histogram bins.
virtual void	SetCropImageHistograms (const bool crop=true)
	Set number of histogram bins.
virtual const XformType *	GetXformByIndex (const size_t idx) const
	Get coordinate transformation for one image in the group.
virtual XformType::SmartPtr	GetXformByIndex (const size_t idx)
	Get coordinate transformation for one image in the group.
virtual const XformType *	GetActiveXformByIndex (const size_t idx) const
	Get coordinate transformation for one active image in the group.
virtual XformType::SmartPtr	GetActiveXformByIndex (const size_t idx)
	Get coordinate transformation for one active image in the group.
Protected Attributes
size_t	m_HistogramBins
	Number of (usable) histogram bins.
size_t	m_HistogramKernelRadiusMax
	Maximal radius of histogram kernels.
float	m_MaxRelativeNumberOutsidePixels
	Threshold for maximum fraction of reformatted pixels from any given image that may be outside FOV.
byte	m_PrivateUserBackgroundValue
	User-defined background value from parent class, transformed to histogram bin index.
Private Member Functions
virtual UniformVolume::SmartPtr	PrepareSingleImage (UniformVolume::SmartPtr &image)
	Prepare data for one image.
virtual void	PrepareTargetImages ()
	Smooth and pre-scale target images.
Private Attributes
bool	m_CropImageHistograms
	Crop image histograms to get rid of high-intensity low-probability samples.

---

Detailed Description

template<class TXform>
class cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >

Base class template for groupwise registration functionals.

This class template adds to its base class all basic functionality that depends on the coordinate transformation model (affine vs. nonrigid) but does not require implementation by explicit specialization. In other words, this class provides the interface that is common to all transformation models.

The next level of derived classes exist in several specialized variants that implement the transformation-dependent interfaces, i.e., member functions that exist only for certain transformation models.

Definition at line 71 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

---

Member Typedef Documentation

template<class TXform>

typedef GroupwiseRegistrationFunctionalXformTemplateBase<TXform> cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::Self

Type of this class.

Reimplemented from cmtk::GroupwiseRegistrationFunctionalBase.

Reimplemented in cmtk::CongealingFunctional< TXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< TXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< AffineXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< SplineWarpXform >, cmtk::GroupwiseRegistrationRMIFunctional< TXform >, cmtk::SplineWarpCongealingFunctional, cmtk::SplineWarpGroupwiseRegistrationRMIFunctional, cmtk::CongealingFunctional< SplineWarpXform >, and cmtk::GroupwiseRegistrationRMIFunctional< SplineWarpXform >.

Definition at line 80 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

typedef SmartPointer<Self> cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::SmartPtr

Smart pointer.

Reimplemented from cmtk::GroupwiseRegistrationFunctionalBase.

Reimplemented in cmtk::CongealingFunctional< TXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< TXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< AffineXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< SplineWarpXform >, cmtk::GroupwiseRegistrationRMIFunctional< TXform >, cmtk::SplineWarpCongealingFunctional, cmtk::SplineWarpGroupwiseRegistrationRMIFunctional, cmtk::CongealingFunctional< SplineWarpXform >, and cmtk::GroupwiseRegistrationRMIFunctional< SplineWarpXform >.

Definition at line 83 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

typedef GroupwiseRegistrationFunctionalBase cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::Superclass

Type of this class.

Reimplemented from cmtk::GroupwiseRegistrationFunctionalBase.

Reimplemented in cmtk::CongealingFunctional< TXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< TXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< AffineXform >, cmtk::GroupwiseRegistrationFunctionalXformTemplate< SplineWarpXform >, cmtk::GroupwiseRegistrationRMIFunctional< TXform >, cmtk::SplineWarpCongealingFunctional, cmtk::SplineWarpGroupwiseRegistrationRMIFunctional, cmtk::CongealingFunctional< SplineWarpXform >, and cmtk::GroupwiseRegistrationRMIFunctional< SplineWarpXform >.

Definition at line 77 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

typedef XformType::SmartPtr cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::XformPointer

Smart pointer to transformation type.

Reimplemented in cmtk::CongealingFunctional< TXform >, cmtk::GroupwiseRegistrationRMIFunctional< TXform >, cmtk::CongealingFunctional< SplineWarpXform >, and cmtk::GroupwiseRegistrationRMIFunctional< SplineWarpXform >.

Definition at line 89 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

typedef TXform cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::XformType

Transformation type.

Reimplemented in cmtk::CongealingFunctional< TXform >, cmtk::GroupwiseRegistrationRMIFunctional< TXform >, cmtk::CongealingFunctional< SplineWarpXform >, and cmtk::GroupwiseRegistrationRMIFunctional< SplineWarpXform >.

Definition at line 86 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

---

Member Function Documentation

template<class TXform>

virtual const XformType* cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::GetActiveXformByIndex

(

const size_t

idx )

const [inline, virtual]

Get coordinate transformation for one active image in the group.

Parameters:

idx	Index of the volume/transformation.

Returns:

Transformation for the selected volume.

Definition at line 128 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

virtual XformType::SmartPtr cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::GetActiveXformByIndex

(

const size_t

idx )

[inline, virtual]

Get coordinate transformation for one active image in the group.

Parameters:

idx	Index of the volume/transformation.

Returns:

Transformation for the selected volume.

Definition at line 137 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

virtual const XformType* cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::GetXformByIndex

(

const size_t

idx )

const [inline, virtual]

Get coordinate transformation for one image in the group.

Parameters:

idx	Index of the volume/transformation.

Returns:

Transformation for the selected volume.

Definition at line 110 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

virtual XformType::SmartPtr cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::GetXformByIndex

(

const size_t

idx )

[inline, virtual]

Get coordinate transformation for one image in the group.

Parameters:

idx	Index of the volume/transformation.

Returns:

Transformation for the selected volume.

Definition at line 119 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

virtual void cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::SetCropImageHistograms

(

const bool

crop = true )

[inline, virtual]

Set number of histogram bins.

Definition at line 101 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

---

Member Data Documentation

template<class TXform>

bool cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::m_CropImageHistograms [private]

Crop image histograms to get rid of high-intensity low-probability samples.

Definition at line 162 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

size_t cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::m_HistogramBins [protected]

Number of (usable) histogram bins.

Definition at line 145 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

Referenced by cmtk::CongealingFunctional< TXform >::CongealingFunctional().

template<class TXform>

size_t cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::m_HistogramKernelRadiusMax [protected]

Maximal radius of histogram kernels.

Definition at line 149 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

float cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::m_MaxRelativeNumberOutsidePixels [protected]

Threshold for maximum fraction of reformatted pixels from any given image that may be outside FOV.

If the number of outside pixels for any one image exceeds this threshold (as a fraction of total number of reformatted pixels) then an exception is thrown.

Definition at line 155 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

template<class TXform>

byte cmtk::GroupwiseRegistrationFunctionalXformTemplateBase< TXform >::m_PrivateUserBackgroundValue [protected]

User-defined background value from parent class, transformed to histogram bin index.

Definition at line 158 of file cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h.

---

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

• libs/Registration/cmtkGroupwiseRegistrationFunctionalXformTemplateBase.h
• libs/Registration/cmtkGroupwiseRegistrationFunctionalXformTemplateBase.cxx