FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric > Class Template Reference
[Metric controller]

Controller class for histogram comparing metrics. More...

#include <freCompareHistogramMetricController.h>

Inheritance diagram for FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >:

[legend]

Collaboration diagram for FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >:

[legend]

List of all members.

Public Types
typedef TControlledCompareHistogramMetric	ComponentType
typedef ComponentType::Pointer	ComponentPointer
typedef HistogramMetricControllerBase < ComponentType >	Superclass
Public Member Functions
	itkTypeMacro (CompareHistogramMetricControllerBase, HistogramMetricControllerBase)
virtual	~CompareHistogramMetricControllerBase ()
Protected Member Functions
	CompareHistogramMetricControllerBase ()
virtual GenericComponentType *	GetSubComponentCasted (ComponentType *pMainComponent, const ComponentID &compID, SessionComponentCache *pMainComponentCache) const
virtual void	SetSubComponentCasted (GenericComponentType *pSubComponent, ComponentType *pMainComponent, const ComponentID compID, SessionComponentCache *pMainComponentCache) const
virtual void	SetMediaCasted (const MediaID &mediaID, GenericMediaType *pMedia, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
virtual void	ActualizeMainComponent (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const

---

Detailed Description

template<class TControlledCompareHistogramMetric>
class FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >

Controller class for histogram comparing metrics.

CompareHistogramMetricControllerBase is derived from HistogramMetricControllerBase and is the basic controller for all histogram metrics derived from itk::CompareHistogramImageToImageMetric (e.g. KullbackLeiblerCompareHistogramImageToImageMetric). This metric computes the similarity between the histogram produced by two images overlapping and a training histogram.

Definition at line 53 of file freCompareHistogramMetricController.h.

---

Member Typedef Documentation

template<class TControlledCompareHistogramMetric>

typedef TControlledCompareHistogramMetric FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::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::HistogramMetricControllerBase< TControlledCompareHistogramMetric >.

Definition at line 56 of file freCompareHistogramMetricController.h.

template<class TControlledCompareHistogramMetric>

typedef ComponentType::Pointer FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::ImageToImageMetricControllerBase< TControlledCompareHistogramMetric >.

Definition at line 57 of file freCompareHistogramMetricController.h.

template<class TControlledCompareHistogramMetric>

typedef HistogramMetricControllerBase<ComponentType> FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::Superclass

Reimplemented from FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >.

Definition at line 58 of file freCompareHistogramMetricController.h.

---

Constructor & Destructor Documentation

template<class TControlledCompareHistogramMetric>

virtual FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::~CompareHistogramMetricControllerBase

(

)

[inline, virtual]

Definition at line 62 of file freCompareHistogramMetricController.h.

template<class TControlledCompareHistogramMetric>

FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::CompareHistogramMetricControllerBase

(

)

[inline, protected]

The Constructor of this class is protected, because this class should be used only as ancestor for derived classes

Definition at line 69 of file freCompareHistogramMetricController.h.

References FREE::cComp_MainInterpolator, FREE::cComp_MainTransform, FREE::CtrlProfile::ProfileOption::CheckForInheritance(), FREE::CtrlProfile::ProfileOption::CheckForIO(), FREE::cParam_MetricMinimize, FREE::cParamDsc_MetricMinimize, FREE::csUndefinedController, FREE::DASet, FREE::CtrlProfile::ControllerProfileBase::Inheritance(), FREE::ControllerID::InterpolatorControllerBase, FREE::ComponentControllerInterface::m_Description, FREE::CtrlProfile::ControllerProfileBase::MediaMap(), FREE::Parameter::PVTBool, FREE::Parameter::PVTDouble, FREE::ControllerID::TransformControllerBase, and FREE::ComponentControllerInterface::UpdateControllerID().

Here is the call graph for this function:

---

Member Function Documentation

template<class TControlledCompareHistogramMetric>

FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::itkTypeMacro	(	CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >	,
		HistogramMetricControllerBase
	)

template<class TControlledCompareHistogramMetric>

virtual GenericComponentType* FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::GetSubComponentCasted	(	ComponentType *	pMainComponent,
		const ComponentID &	compID,
		SessionComponentCache *	pMainComponentCache
	)			const [inline, protected, virtual]

Returns the subcomponent specified by the ComponentID. If the component ID is not defined, the return is NULL.
Reimplement the virtual variant of this member function to realize special controller behavior. This version is only for establishing a generic interface.

Parameters:

[in]	pMainComponent	Pointer to the casted main component, containing the wanted subcomponent.
[in]	compID	ID specifying the wanted subcomponent.
[in]	pMainComponentCache	Pointer to the cache of the main component.

Reimplemented from FREE::ComponentControllerBase< TControlledCompareHistogramMetric >.

Definition at line 107 of file freCompareHistogramMetricController.h.

References FREE::ComponentControllerBase< TControlledMetric >::GetSubComponentCasted().

Here is the call graph for this function:

template<class TControlledCompareHistogramMetric>

virtual void FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::SetSubComponentCasted	(	GenericComponentType *	pSubComponent,
		ComponentType *	pMainComponent,
		const ComponentID	compID,
		SessionComponentCache *	pMainComponentCache
	)			const [inline, protected, virtual]

Definition at line 116 of file freCompareHistogramMetricController.h.

References FREE::ComponentControllerBase< TControlledMetric >::SetSubComponentCasted().

Here is the call graph for this function:

template<class TControlledCompareHistogramMetric>

virtual void FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::SetMediaCasted	(	const MediaID &	mediaID,
		GenericMediaType *	pMedia,
		ComponentType *	pComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const [inline, protected, virtual]

Definition at line 124 of file freCompareHistogramMetricController.h.

References FREE::ComponentControllerBase< TControlledMetric >::SetMediaCasted().

Here is the call graph for this function:

template<class TControlledCompareHistogramMetric>

virtual void FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::ActualizeMainComponent	(	ComponentType *	pMainComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		const unsigned int &	iActLevel
	)			const [inline, protected, virtual]

This function (called by ActualizeComponent()) actualizes the passed component with the setup information considering the actual resolution level of the ongoing registration. In a derived class this function should be overridden, to provide a specific behavior. For more information see ControllerBase::ActualizeMainComponent.

Reimplemented from FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >.

Definition at line 134 of file freCompareHistogramMetricController.h.

References FREE::HistogramMetricControllerBase< TControlledMetric >::ActualizeMainComponent(), FREE::Parameter::GetParameterLayer(), FREE::Parameter::LayerCount(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

---

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

• freCompareHistogramMetricController.h

---