#include <frePointSetRegistrationControllerBase.h>


PointSetRegistrationControllerBase is derived from RegistrationProcessorControllerBase and is the controller for RigidRegistration implemented by RigidRegistrationProcessor.
Definition at line 42 of file frePointSetRegistrationControllerBase.h.
| typedef TControlledRigidProcessor FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::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::RegistrationProcessorControllerBase< TControlledRigidProcessor >.
Reimplemented in FREE::PointSet2DRegistrationController, and FREE::PointSet3DRegistrationController.
Definition at line 45 of file frePointSetRegistrationControllerBase.h.
| typedef RegistrationProcessorControllerBase<ComponentType> FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::Superclass |
Reimplemented from FREE::RegistrationProcessorControllerBase< TControlledRigidProcessor >.
Reimplemented in FREE::PointSet2DRegistrationController, and FREE::PointSet3DRegistrationController.
Definition at line 46 of file frePointSetRegistrationControllerBase.h.
| typedef PointSetRegistrationControllerBase<ComponentType> FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::Self |
Definition at line 47 of file frePointSetRegistrationControllerBase.h.
| typedef ComponentType::Pointer FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::ComponentPointer |
SmartPointer of the component class
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 49 of file frePointSetRegistrationControllerBase.h.
| typedef Superclass::GenericComponentType FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GenericComponentType |
Generic component type
Reimplemented from FREE::RegistrationProcessorControllerBase< TControlledRigidProcessor >.
Definition at line 50 of file frePointSetRegistrationControllerBase.h.
| typedef Superclass::GenericComponentPointer FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GenericComponentPointer |
Generic smartpointer for the controller interface
Reimplemented from FREE::RegistrationProcessorControllerBase< TControlledRigidProcessor >.
Definition at line 51 of file frePointSetRegistrationControllerBase.h.
| typedef Superclass::GenericMediaPointer FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GenericMediaPointer |
Reimplemented from FREE::RegistrationProcessorControllerBase< TControlledRigidProcessor >.
Definition at line 52 of file frePointSetRegistrationControllerBase.h.
| FREE::PointSetRegistrationControllerBase< ComponentType >::PointSetRegistrationControllerBase | ( | ) | [inline, protected] |
Definition at line 141 of file frePointSetRegistrationControllerBase.txx.
References FREE::ComponentControllerInterface::m_Description, FREE::ControllerID::OptimizerOwnerControllerBase, and FREE::ComponentControllerInterface::UpdateControllerID().

| FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::DeclareParameterMacro | ( | PersistentFinalField | ) |
| FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::DeclareMediaIDMacro | ( | fixedPointSet | ) |
| FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::DeclareMediaIDMacro | ( | movingPointSet | ) |
| FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::DeclareMediaIDMacro | ( | fieldReference | ) |
| FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::DeclareMediaIDMacro | ( | finalField | ) |
| FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::DeclareMediaIDMacro | ( | finalTransform | ) |
| FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::DeclareMediaIDMacro | ( | finalInverseTransform | ) |
| FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::itkTypeMacro | ( | PointSetRegistrationControllerBase< TControlledRigidProcessor > | , | |
| RegistrationProcessorControllerBase | ||||
| ) |
| ValidityTag::Pointer FREE::PointSetRegistrationControllerBase< ComponentType >::GetMediaValidityTagRequirement | ( | const MediaID & | mediaID, | |
| SessionComponentCache * | pComponentCache | |||
| ) | const [inline, virtual] |
Retrieves the validity tag requirement of the media specified by the mediaID. The requirement is the most up to date ValidityTag in the dependency chain of a media component.
Reimplement GetMediaValidityTagRequirement() to realize special controller behavior accordingly a certain dependency chain.
This version returns only the ValidityTag of the specified media; thus the media has no dependencies.
| [in] | mediaID | ID specifying the wanted media. |
| [in] | pComponentCache | Pointer to the component cache. |
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 102 of file frePointSetRegistrationControllerBase.txx.
References FREE::ComponentControllerBase< TControlledProcessor >::GetMediaValidityTagRequirement(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetValidityTagRequirement(), and FREE::ValidityTag::New().
Referenced by FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted().

| bool FREE::PointSetRegistrationControllerBase< ComponentType >::GetMinimizeToOptimize | ( | const SessionComponentCache * | pComponentCache | ) | const [inline, virtual] |
Method indicates if an optimizer should maximize or minimize to fullfill the interests of the owner. This function is used by the controllers of optimizer subcomponents to set their managed component properly.
| pComponentCache | Pointer to the component cache of the optimizer owner |
Implements FREE::OptimizerOwnerControllerInterface.
Definition at line 408 of file frePointSetRegistrationControllerBase.txx.
References FREE::cComp_MainMetric, FREE::SessionComponentCache::Controller(), FREE::SessionComponentCache::ControllerIsAssigned(), FREE::cParam_MetricMinimize, FREE::SessionComponentCache::GetConstCacheByIDPath(), FREE::ComponentControllerInterface::GetParameter(), and throwCtrlExceptionMacro.

| Parameter::Pointer FREE::PointSetRegistrationControllerBase< ComponentType >::GetParameter | ( | const SessionComponentCache * | pComponentCache, | |
| const std::string & | sParameterName | |||
| ) | const [inline, virtual] |
Returns a smart pointer to the specified parameter which is provided by the component controller. To address the component, parameter, layer and value index an IDPath is used: ComponentName\.. (e.g. component@StepSize)
| [in] | pComponentCache | Pointer to component where the parameter should be located. |
| [in] | sParameterName | Name of the parameter with the wanted value. |
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 392 of file frePointSetRegistrationControllerBase.txx.
References FREE::ComponentControllerBase< TControlledProcessor >::GetParameter(), and FREE::Parameter::New().

| void FREE::PointSetRegistrationControllerBase< ComponentType >::GenerateProfile | ( | CtrlProfile::ControllerProfile & | profile, | |
| const SessionComponentCache * | pComponentCache, | |||
| bool | bRegardOldSetup | |||
| ) | const [inline, protected, virtual] |
Adjusts the current profile according to the definitions of the controller.
Method should call the superclass variant to regard demands of basic controllers.
| [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::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 152 of file frePointSetRegistrationControllerBase.txx.
References FREE::cComp_MainMetric, FREE::cComp_MainOptimizer, FREE::cComp_MainTransform, FREE::cCompDsc_MainMetric, FREE::cCompDsc_MainOptimizer, FREE::cCompDsc_MainTransform, FREE::CtrlProfile::ProfileOption::CheckForInheritance(), FREE::CtrlProfile::ProfileOption::CheckForIO(), FREE::csUndefinedController, FREE::DAGet, FREE::DASet, FREE::ComponentControllerBase< TControlledProcessor >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::Inheritance(), FREE::ControllerID::MediaControllerBase, FREE::CtrlProfile::ControllerProfileBase::MediaMap(), FREE::ControllerID::MVNonLinearOptimizerControllerBase, FREE::CtrlProfile::ControllerProfileBase::Parameters(), FREE::Parameter::PVTBool, FREE::CtrlProfile::ControllerProfile::Requirements(), and FREE::CtrlProfile::ControllerProfileBase::SubComponents().

| PointSetRegistrationControllerBase< ComponentType >::ComponentPointer FREE::PointSetRegistrationControllerBase< ComponentType >::BuildMainComponent | ( | ComponentSetup * | pComponentSetup, | |
| SessionComponentCache * | pComponentCache | |||
| ) | const [inline, protected, virtual] |
This function (called by BuildSetup()) creates an object of the controlled class by the use of the passed setup information and initializes other elements in the cache if required.
In a derived class this function should be overridden if a simple instantiation is not sufficient.
| [in] | pComponentSetup | The setup information for the component that should be build. |
| [in,out] | pComponentCache | Pointer to the component cache associated with the component. The component will be automatically added to the cache by the BuildSetup() |
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 77 of file frePointSetRegistrationControllerBase.txx.
References FREE::ComponentControllerBase< TControlledProcessor >::BuildMainComponent(), FREE::ValidityTag::NewNull(), FREE::DirectSessionComponentAccessor::SetRepositoryElement(), and FREE::SessionComponentRepositoryKeys::Validity().

| void FREE::PointSetRegistrationControllerBase< ComponentType >::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.
| [in,out] | pMainComponent | Pointer to the main component. Can also be retrieved via component cache, but offered directly and already casted for more convenience. |
| [in,out] | pComponentCache | Pointer to the component cache that should be actualized. |
| [in] | pSessionInfo | Pointer to the session info. |
| [in] | iActLevel | Indicates which layer of a parameter should be used, if the parameter is layer sensitive (e.g. as resolution level of a registration). Default is 0. |
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 87 of file frePointSetRegistrationControllerBase.txx.
References FREE::RegistrationProcessorControllerBase< TControlledProcessor >::ActualizeMainComponent().

| PointSetRegistrationControllerBase< ComponentType >::GenericComponentType * FREE::PointSetRegistrationControllerBase< ComponentType >::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.
| [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< TControlledRigidProcessor >.
Definition at line 213 of file frePointSetRegistrationControllerBase.txx.
References FREE::cComp_MainMetric, FREE::cComp_MainOptimizer, FREE::cComp_MainTransform, and FREE::ComponentControllerBase< TControlledProcessor >::GetSubComponentCasted().

| void FREE::PointSetRegistrationControllerBase< ComponentType >::SetSubComponentCasted | ( | GenericComponentType * | pSubComponent, | |
| ComponentType * | pMainComponent, | |||
| const ComponentID | compID, | |||
| SessionComponentCache * | pMainComponentCache | |||
| ) | const [inline, protected, virtual] |
Definition at line 226 of file frePointSetRegistrationControllerBase.txx.
References FREE::cComp_MainMetric, FREE::cComp_MainOptimizer, FREE::cComp_MainTransform, and FREE::ComponentControllerBase< TControlledProcessor >::SetSubComponentCasted().

| PointSetRegistrationControllerBase< ComponentType >::GenericMediaPointer FREE::PointSetRegistrationControllerBase< ComponentType >::GetMediaCasted | ( | const MediaID & | mediaID, | |
| ComponentType * | pComponent, | |||
| SessionComponentCache * | pComponentCache, | |||
| SessionInfo * | pSessionInfo | |||
| ) | const [inline, protected, virtual] |
Returns the media specified by the MediaID. If the media ID is not handled, an exception will be thrown.
Reimplement this member function to realize special controller behavior. This version is only for establishing a generic interface.
| [in] | mediaID | ID specifying the wanted media. |
| [in] | pComponent | Pointer to the casted component of the passed cache. |
| [in] | pComponentCache | Pointer to the component cache. |
| [in] | pSessionInfo | Pointer to the session info. |
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 238 of file frePointSetRegistrationControllerBase.txx.
References FREE::SessionBuilder::ActualizeComponent(), FREE::ComponentControllerBase< TControlledRigidProcessor >::ActualizeMediaValidityTag(), FREE::ComponentControllerBase< TControlledRigidProcessor >::ActualizeValidityTag(), FREE::ComponentControllerBase< TControlledRigidProcessor >::AddStatisticEntry(), catchAllNPassMacro, FREE::StatisticEntry::CloseEntry(), FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::SessionAccessor::GetMedia(), FREE::ComponentControllerBase< TControlledProcessor >::GetMediaCasted(), FREE::ComponentControllerBase< TControlledRigidProcessor >::GetMediaValidityTag(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaValidityTagRequirement(), FREE::SessionAccessor::GetParameterValue(), FREE::DirectSessionComponentAccessor::GetRepositoryElement(), FREE::ComponentControllerBase< TControlledRigidProcessor >::GetValidityTag(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetValidityTagRequirement(), FREE::SessionBuilder::LinkMediaToComponent(), FREE::ComponentSetup::MediaLinks(), FREE::ComponentControllerBase< TControlledRigidProcessor >::NotifyProgress(), FREE::ComponentControllerBase< TControlledRigidProcessor >::ResetComponent(), FREE::DirectSessionComponentAccessor::SetRepositoryElement(), FREE::SessionComponentCache::Setup(), and throwCtrlExceptionMacro.

| void FREE::PointSetRegistrationControllerBase< ComponentType >::SetMediaCasted | ( | const MediaID & | mediaID, | |
| GenericMediaType * | pMedia, | |||
| ComponentType * | pComponent, | |||
| SessionComponentCache * | pComponentCache, | |||
| SessionInfo * | pSessionInfo | |||
| ) | const [inline, protected, virtual] |
Definition at line 369 of file frePointSetRegistrationControllerBase.txx.
References FREE::ComponentControllerBase< TControlledRigidProcessor >::ActualizeMediaValidityTag(), and FREE::ComponentControllerBase< TControlledProcessor >::SetMediaCasted().

| ValidityTag::Pointer FREE::PointSetRegistrationControllerBase< ComponentType >::GetValidityTagRequirement | ( | const std::string & | id, | |
| SessionComponentCache * | pComponentCache | |||
| ) | const [inline, protected, virtual] |
Retrieves the validity tag requirement of the element specified by the id. The requirement is the most up to date ValidityTag in the dependency chain of an element.
Unlike the other ValidityTagRequirement getter this one is only used internally by the controller for managing validities. (e.g. if the registration process is up to date even if no result media are computed yet).
Reimplement GetValidityTagRequirement() to realize special controller behavior for a certain dependency chain.
This version returns only the ValidityTag of the specified media; thus the element has no dependencies.
| [in] | ID | Specifying the wanted element. |
| [in] | pComponentCache | Pointer to the component cache. |
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 123 of file frePointSetRegistrationControllerBase.txx.
References FREE::ProcessorControllerBase< TControlledRigidProcessor >::CompareValidityTagRequirement(), FREE::ComponentControllerBase< TControlledProcessor >::GetMediaValidityTagRequirement(), and FREE::ValidityTag::New().
Referenced by FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), and FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaValidityTagRequirement().

| void FREE::PointSetRegistrationControllerBase< ComponentType >::ResetMainComponent | ( | SessionComponentCache * | pComponentCache, | |
| SessionInfo * | pSessionInfo | |||
| ) | const [inline, protected, virtual] |
This function (called by ResetComponent()) resets the component of the passed cached. The default implementation is an simple recreation of the component and the reseting in the cache. In a derived class this function should be overridden, to provide a specific behavior.
| [in,out] | pComponentCache | Pointer to the component cache, that should be actualized. |
| [in] | pSessionInfo | Pointer to the session info. |
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 463 of file frePointSetRegistrationControllerBase.txx.
| void FREE::PointSetRegistrationControllerBase< ComponentType >::ResetSubComponents | ( | SessionComponentCache * | pComponentCache, | |
| SessionInfo * | pSessionInfo | |||
| ) | const [inline, protected, virtual] |
This function (called by ResetComponent()) resets all subcomponents In a derived class this function should be overridden, if a simple ResetComponent() call of all subcomponents is is not sufficient.
| [in,out] | pComponentCache | Pointer to the component cache, that should be actualized. |
| [in] | pSessionInfo | Pointer to the session info. |
Reimplemented from FREE::ComponentControllerBase< TControlledRigidProcessor >.
Definition at line 430 of file frePointSetRegistrationControllerBase.txx.
References catchAllNPassMacro, FREE::cComp_MainMetric, FREE::cComp_MainOptimizer, FREE::SessionComponentCache::Component(), FREE::SessionComponentCache::Controller(), FREE::SessionComponentCache::ControllerIsAssigned(), FREE::ComponentControllerInterface::ResetComponent(), FREE::ComponentControllerBase< TControlledRigidProcessor >::SetSubComponent(), FREE::SessionComponentCache::SubCaches(), and throwCtrlExceptionMacro.

1.5.3 written by Dimitri van Heesch,
© 1997-2000