FREE::ImageToImageMetricControllerBase< TControlledMetric > Class Template Reference
[Basic controllers, Metric controller]

Derived class of a controller objects for metrics. More...

#include <freImageToImageMetricControllerBase.h>

Inheritance diagram for FREE::ImageToImageMetricControllerBase< TControlledMetric >:

[legend]

Collaboration diagram for FREE::ImageToImageMetricControllerBase< TControlledMetric >:

[legend]

List of all members.

Public Types
typedef TControlledMetric	ComponentType
typedef ComponentType::Pointer	ComponentPointer
typedef SingleValuedMetricControllerBase < TControlledMetric >	Superclass
Public Member Functions
	itkTypeMacro (ImageToImageMetricControllerBase, SingleValuedMetricControllerBase)
void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
Protected Member Functions
	ImageToImageMetricControllerBase ()
	DeclareMediaIDMacro (fixedImage)
	DeclareMediaIDMacro (movingImage)

---

Detailed Description

template<class TControlledMetric>
class FREE::ImageToImageMetricControllerBase< TControlledMetric >

Derived class of a controller objects for metrics.

ImageToImageMetricControllerBase is derived from SingleValuedMetricControllerBase and the base class for the control of multiple valued metrics (based on itk::ImageToImageMetric). This class should be used as base for new multiple valued metric controllers.

Definition at line 42 of file freImageToImageMetricControllerBase.h.

---

Member Typedef Documentation

template<class TControlledMetric>

typedef TControlledMetric FREE::ImageToImageMetricControllerBase< TControlledMetric >::ComponentType

The component class managed by the controller. The component class must be a derivation from itk::LightObject to ensure the ability to use the smartpointer concept of itk

Reimplemented from FREE::MetricControllerBase< TControlledMetric >.

Reimplemented in FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >, FREE::PointSupported2DMetricController, FREE::PointSupported3DMetricController, FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >, FREE::CorrelationCoefficientHistogramMetricControlleBase< TImageType >, FREE::HistogramMetricControllerBase< TControlledMetric >, FREE::MattesMutualInformationMetricControllerBase< TImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< TImageType >, FREE::MeanSquaresMetricControllerBase< TControlledMetric >, FREE::MeanSquares2DMetricController, FREE::MeanSquares3DMetricController, FREE::MutualInformationHistogramMetricControllerBase< TImageType >, FREE::MutualInformationMetricControllerBase< TImageType >, FREE::NormalizedCorrelationMetricControllerBase< TControlledMetric >, FREE::NormalizedCorrelation2DMetricController, FREE::NormalizedCorrelation3DMetricController, FREE::PointSupportedMetricControllerBase< ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::PointSetType >, FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >, FREE::CorrelationCoefficientHistogramMetricControlleBase< ImageTypes< 2 >::InternalImageType >, FREE::CorrelationCoefficientHistogramMetricControlleBase< ImageTypes< 3 >::InternalImageType >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< FREE::ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< TImageType, TImageType > >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< TImageType, TImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< FREE::ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::InternalImageType > >, FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >, FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MeanSquaresMetricControllerBase< itk::MeanSquaresImageToImageMetric< ImageTypes< 3 >::InternalImageType, ImageTypes< 3 >::InternalImageType > >, FREE::MeanSquaresMetricControllerBase< itk::MeanSquaresImageToImageMetric< ImageTypes< 2 >::InternalImageType, ImageTypes< 2 >::InternalImageType > >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MutualInformationMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::NormalizedCorrelationMetricControllerBase< itk::NormalizedCorrelationImageToImageMetric< ImageTypes< 3 >::InternalImageType, ImageTypes< 3 >::InternalImageType > >, and FREE::NormalizedCorrelationMetricControllerBase< itk::NormalizedCorrelationImageToImageMetric< ImageTypes< 2 >::InternalImageType, ImageTypes< 2 >::InternalImageType > >.

Definition at line 51 of file freImageToImageMetricControllerBase.h.

template<class TControlledMetric>

typedef ComponentType::Pointer FREE::ImageToImageMetricControllerBase< TControlledMetric >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::ComponentControllerBase< TControlledMetric >.

Reimplemented in FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >.

Definition at line 52 of file freImageToImageMetricControllerBase.h.

template<class TControlledMetric>

typedef SingleValuedMetricControllerBase<TControlledMetric> FREE::ImageToImageMetricControllerBase< TControlledMetric >::Superclass

Reimplemented from FREE::MetricControllerBase< TControlledMetric >.

Reimplemented in FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >, FREE::PointSupported2DMetricController, FREE::PointSupported3DMetricController, FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >, FREE::CorrelationCoefficientHistogramMetricControlleBase< TImageType >, FREE::HistogramMetricControllerBase< TControlledMetric >, FREE::MattesMutualInformationMetricControllerBase< TImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< TImageType >, FREE::MeanSquaresMetricControllerBase< TControlledMetric >, FREE::MeanSquares2DMetricController, FREE::MeanSquares3DMetricController, FREE::MutualInformationHistogramMetricControllerBase< TImageType >, FREE::MutualInformationMetricControllerBase< TImageType >, FREE::NormalizedCorrelationMetricControllerBase< TControlledMetric >, FREE::NormalizedCorrelation2DMetricController, FREE::NormalizedCorrelation3DMetricController, FREE::PointSupportedMetricControllerBase< ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::PointSetType >, FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >, FREE::CorrelationCoefficientHistogramMetricControlleBase< ImageTypes< 2 >::InternalImageType >, FREE::CorrelationCoefficientHistogramMetricControlleBase< ImageTypes< 3 >::InternalImageType >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< FREE::ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< TImageType, TImageType > >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< TImageType, TImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< FREE::ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::InternalImageType > >, FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >, FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MeanSquaresMetricControllerBase< itk::MeanSquaresImageToImageMetric< ImageTypes< 3 >::InternalImageType, ImageTypes< 3 >::InternalImageType > >, FREE::MeanSquaresMetricControllerBase< itk::MeanSquaresImageToImageMetric< ImageTypes< 2 >::InternalImageType, ImageTypes< 2 >::InternalImageType > >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MutualInformationMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::NormalizedCorrelationMetricControllerBase< itk::NormalizedCorrelationImageToImageMetric< ImageTypes< 3 >::InternalImageType, ImageTypes< 3 >::InternalImageType > >, and FREE::NormalizedCorrelationMetricControllerBase< itk::NormalizedCorrelationImageToImageMetric< ImageTypes< 2 >::InternalImageType, ImageTypes< 2 >::InternalImageType > >.

Definition at line 53 of file freImageToImageMetricControllerBase.h.

---

Constructor & Destructor Documentation

template<class TControlledMetric>

FREE::ImageToImageMetricControllerBase< TControlledMetric >::ImageToImageMetricControllerBase

(

)

[inline, protected]

Definition at line 55 of file freImageToImageMetricControllerBase.txx.

References FREE::ComponentControllerInterface::m_Description, and FREE::ComponentControllerInterface::UpdateControllerID().

Here is the call graph for this function:

---

Member Function Documentation

template<class TControlledMetric>

FREE::ImageToImageMetricControllerBase< TControlledMetric >::DeclareMediaIDMacro

(

fixedImage

)

[protected]

template<class TControlledMetric>

FREE::ImageToImageMetricControllerBase< TControlledMetric >::DeclareMediaIDMacro

(

movingImage

)

[protected]

template<class TControlledMetric>

FREE::ImageToImageMetricControllerBase< TControlledMetric >::itkTypeMacro	(	ImageToImageMetricControllerBase< TControlledMetric >	,
		SingleValuedMetricControllerBase
	)

template<class TControlledMetric>

void FREE::ImageToImageMetricControllerBase< TControlledMetric >::GenerateProfile	(	CtrlProfile::ControllerProfile &	profile,
		const SessionComponentCache *	pComponentCache,
		bool	bRegardOldSetup
	)			const [inline, virtual]

Adjusts the current profile according to the definitions of the controller.
Method should call the superclass variant to regard demands of basic controllers.

Parameters:

[in,out]	profile	Reference of the current profile.
[in]	pComponentCache	Pointer to the cache indicating the location of the component that should be profiled. This pointer can be null. In this case only a default profile that isn't context sensitive is wanted (others aren't possible anyway)
[in]	bRegardOldSetup	If true, the setup of pComponentCache is valid and should be regarded when the profile is generated. Otherwise just use defaults if setup information is needed.

Reimplemented from FREE::MetricControllerBase< TControlledMetric >.

Reimplemented in FREE::PointSupportedMetricControllerBase< TImageType, TPointSet >, FREE::HistogramMetricControllerBase< TControlledMetric >, FREE::MattesMutualInformationMetricControllerBase< TImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< TImageType >, FREE::MutualInformationHistogramMetricControllerBase< TImageType >, FREE::MutualInformationMetricControllerBase< TImageType >, FREE::PointSupportedMetricControllerBase< ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::PointSetType >, FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< FREE::ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< TImageType, TImageType > >, FREE::HistogramMetricControllerBase< itk::CorrelationCoefficientHistogramImageToImageMetric< TImageType, TImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::InternalImageType > >, FREE::HistogramMetricControllerBase< itk::MutualInformationHistogramImageToImageMetric< FREE::ImageTypes< 2 >::InternalImageType, FREE::ImageTypes< 2 >::InternalImageType > >, FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >, FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MeanReciprocalSquaresMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 2 >::InternalImageType >, FREE::MutualInformationHistogramMetricControllerBase< ImageTypes< 3 >::InternalImageType >, FREE::MutualInformationMetricControllerBase< ImageTypes< 2 >::InternalImageType >, and FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >.

Definition at line 64 of file freImageToImageMetricControllerBase.txx.

References FREE::DASet, FREE::MetricControllerBase< TControlledMetric >::GenerateProfile(), and FREE::CtrlProfile::ControllerProfileBase::MediaMap().

Referenced by FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::GenerateProfile(), FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), FREE::MeanReciprocalSquaresMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), and FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >::GenerateProfile().

Here is the call graph for this function:

---

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

• freImageToImageMetricControllerBase.h
• freImageToImageMetricControllerBase.txx

---