FREE::MatrixOffsetTransformControllerBase

FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension > Class Template Reference
[Transformation controller]

Basic controller class for translations based on itk::MatrixOffsetTransformBase. More...

#include <freMatrixOffsetTransformControllerBase.h>

Inheritance diagram for FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >:

Inheritance graph
FREE::AffineTransformControllerBase\< itk::AffineTransform\< double, iDimension \>, iDimension \>FREE::AffineTransformControllerBase\< 2 \>FREE::AffineTransformControllerBase\< 3 \>FREE::CenteredAffineTransformControllerBase\< itk::CenteredAffineTransform\< double, iDimension \>, iDimension \>FREE::CenteredAffineTransformControllerBase\< 2 \>FREE::CenteredAffineTransformControllerBase\< 3 \>FREE::CenteredEuler3DTransformController\< itk::CenteredEuler3DTransform\< double \>, 3 \>FREE::CenteredRigid2DTransformController\< itk::CenteredRigid2DTransform\< double \>, 2 \>FREE::Euler3DTransformController\< itk::Euler3DTransform\< double \>, 3 \>FREE::Rigid2DTransformController\< itk::Rigid2DTransform\< double \>, 2 \>FREE::Similarity2DTransformController\< itk::Similarity2DTransform\< double \>, 2 \>FREE::VersorRigid3DTransformController\< itk::VersorRigid3DTransform\< double \>, 3 \>FREE::VersorTransformController\< itk::VersorTransform\< double \>, 3 \>FREE::ITKTransformControllerBase\< TMatrixOffsetTransform, VDimension \>FREE::TransformControllerBase\< TMatrixOffsetTransform, VDimension \>FREE::ComponentControllerBase\< TMatrixOffsetTransform \>FREE::ComponentControllerInterfaceFREE::ITKTransformControllerInterface\< TMatrixOffsetTransform::ScalarType, TMatrixOffsetTransform::InputSpaceDimension, TMatrixOffsetTransform::OutputSpaceDimension \>FREE::Affine2DTransformControllerFREE::Affine3DTransformControllerFREE::CenteredAffine2DTransformControllerFREE::CenteredAffine3DTransformController
[legend]
Collaboration diagram for FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >:

Collaboration graph
FREE::ITKTransformControllerBase\< TMatrixOffsetTransform, VDimension \>FREE::TransformControllerBase\< TMatrixOffsetTransform, VDimension \>FREE::ComponentControllerBase\< TMatrixOffsetTransform \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObjectFREE::ITKTransformControllerInterface\< TMatrixOffsetTransform::ScalarType, TMatrixOffsetTransform::InputSpaceDimension, TMatrixOffsetTransform::OutputSpaceDimension \>
[legend]

List of all members.

Public Types

typedef
TMatrixOffsetTransform 		ComponentType
typedef
ITKTransformControllerBase
< TMatrixOffsetTransform,
VDimension > 		Superclass
typedef
Superclass::GenericComponentType 		GenericComponentType
typedef
Superclass::GenericComponentPointer 		GenericComponentPointer

Public Member Functions

virtual const char * GetNameOfClass () const
 DeclareParameterMacro (CenterInitializationType)
 DeclareParameterMacro (Center)
 DeclareMediaIDMacro (movingInitialImage)
 DeclareMediaIDMacro (fixedInitialImage)

Protected Member Functions

 MatrixOffsetTransformControllerBase ()
virtual void SetMediaCasted (const MediaID &mediaID, GenericMediaType *pMedia, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
virtual void GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
bool SetInitialTransformValues (ComponentType *pTransformComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const int &iInitializeByITV) const
virtual void CopyFixedParameters (ComponentType *pOrigin, ComponentType *pDestination) const

Detailed Description

template<class TMatrixOffsetTransform, unsigned int VDimension>
class FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >

Basic controller class for translations based on itk::MatrixOffsetTransformBase.

Definition at line 37 of file freMatrixOffsetTransformControllerBase.h.

Member Typedef Documentation

template<class TMatrixOffsetTransform, unsigned int VDimension>
typedef TMatrixOffsetTransform FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::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::ITKTransformControllerBase< TMatrixOffsetTransform, VDimension >.

Reimplemented in FREE::AffineTransformControllerBase< iDimension >, FREE::CenteredAffineTransformControllerBase< iDimension >, FREE::CenteredEuler3DTransformController, FREE::CenteredRigid2DTransformController, FREE::Euler3DTransformController, FREE::Rigid2DTransformController, FREE::Similarity2DTransformController, FREE::VersorRigid3DTransformController, FREE::VersorTransformController, FREE::AffineTransformControllerBase< 2 >, FREE::AffineTransformControllerBase< 3 >, FREE::CenteredAffineTransformControllerBase< 2 >, and FREE::CenteredAffineTransformControllerBase< 3 >.

Definition at line 40 of file freMatrixOffsetTransformControllerBase.h.

template<class TMatrixOffsetTransform, unsigned int VDimension>
typedef ITKTransformControllerBase<TMatrixOffsetTransform, VDimension> FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::Superclass

Reimplemented from FREE::ITKTransformControllerBase< TMatrixOffsetTransform, VDimension >.

Reimplemented in FREE::AffineTransformControllerBase< iDimension >, FREE::CenteredAffineTransformControllerBase< iDimension >, FREE::CenteredEuler3DTransformController, FREE::CenteredRigid2DTransformController, FREE::Euler3DTransformController, FREE::Rigid2DTransformController, FREE::Similarity2DTransformController, FREE::VersorRigid3DTransformController, FREE::VersorTransformController, FREE::AffineTransformControllerBase< 2 >, FREE::AffineTransformControllerBase< 3 >, FREE::CenteredAffineTransformControllerBase< 2 >, and FREE::CenteredAffineTransformControllerBase< 3 >.

Definition at line 41 of file freMatrixOffsetTransformControllerBase.h.

template<class TMatrixOffsetTransform, unsigned int VDimension>
typedef Superclass::GenericComponentType FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::GenericComponentType

Reimplemented from FREE::ITKTransformControllerBase< TMatrixOffsetTransform, VDimension >.

Definition at line 43 of file freMatrixOffsetTransformControllerBase.h.

template<class TMatrixOffsetTransform, unsigned int VDimension>
typedef Superclass::GenericComponentPointer FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::GenericComponentPointer

Reimplemented from FREE::ITKTransformControllerBase< TMatrixOffsetTransform, VDimension >.

Definition at line 44 of file freMatrixOffsetTransformControllerBase.h.

Constructor & Destructor Documentation

template<class TMatrixOffsetTransform, unsigned int VDimension>
FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::MatrixOffsetTransformControllerBase (  )  [inline, protected]

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

Definition at line 37 of file freMatrixOffsetTransformControllerBase.txx.

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

Here is the call graph for this function:

FREE::ComponentControllerInterface::UpdateControllerIDFREE::CtrlProfile::ProfileInheritance::AddAncestorFREE::XMLStringMultiMap::AddElementFREE::CtrlProfile::ProfileInheritance::IndexOfAncestorFREE::XMLStringMultiMap::SetElementDataFREE::XMLStringMultiMap::GetElementDataFREE::XMLStringMultiMap::Size

Member Function Documentation

template<class TMatrixOffsetTransform, unsigned int VDimension>
virtual const char* FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::GetNameOfClass (  )  const [inline, virtual]

Reimplemented from FREE::ITKTransformControllerBase< TMatrixOffsetTransform, VDimension >.

Reimplemented in FREE::AffineTransformControllerBase< iDimension >, FREE::Affine2DTransformController, FREE::Affine3DTransformController, FREE::CenteredAffineTransformControllerBase< iDimension >, FREE::CenteredAffine2DTransformController, FREE::CenteredAffine3DTransformController, FREE::CenteredEuler3DTransformController, FREE::CenteredRigid2DTransformController, FREE::Euler3DTransformController, FREE::Rigid2DTransformController, FREE::Similarity2DTransformController, FREE::VersorRigid3DTransformController, FREE::VersorTransformController, FREE::AffineTransformControllerBase< 2 >, FREE::AffineTransformControllerBase< 3 >, FREE::CenteredAffineTransformControllerBase< 2 >, and FREE::CenteredAffineTransformControllerBase< 3 >.

Definition at line 46 of file freMatrixOffsetTransformControllerBase.h.

template<class TMatrixOffsetTransform, unsigned int VDimension>
FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::DeclareParameterMacro ( CenterInitializationType   ) 

Reimplemented in FREE::VersorRigid3DTransformController.

template<class TMatrixOffsetTransform, unsigned int VDimension>
FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::DeclareParameterMacro ( Center   ) 

Reimplemented in FREE::VersorRigid3DTransformController.

template<class TMatrixOffsetTransform, unsigned int VDimension>
FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::DeclareMediaIDMacro ( movingInitialImage   ) 

template<class TMatrixOffsetTransform, unsigned int VDimension>
FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::DeclareMediaIDMacro ( fixedInitialImage   ) 

template<class TMatrixOffsetTransform, unsigned int VDimension>
void FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::SetMediaCasted ( const MediaID &  mediaID,
GenericMediaType *  pMedia,
ComponentType *  pComponent,
SessionComponentCache *  pComponentCache,
SessionInfo *  pSessionInfo 
) const [inline, protected, virtual]

Definition at line 75 of file freMatrixOffsetTransformControllerBase.txx.

References FREE::TransformControllerBase< TMatrixOffsetTransform, VDimension >::SetMediaCasted(), and FREE::DirectSessionComponentAccessor::SetRepositoryElement().

Here is the call graph for this function:

FREE::TransformControllerBase\< TMatrixOffsetTransform, VDimension \>::SetMediaCastedFREE::DirectSessionComponentAccessor::SetRepositoryElement

template<class TMatrixOffsetTransform, unsigned int VDimension>
void FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::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.

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::TransformControllerBase< TMatrixOffsetTransform, VDimension >.

Reimplemented in FREE::Affine2DTransformController, FREE::Affine3DTransformController, FREE::CenteredAffineTransformControllerBase< iDimension >, FREE::CenteredAffine2DTransformController, FREE::CenteredAffine3DTransformController, FREE::CenteredEuler3DTransformController, FREE::CenteredRigid2DTransformController, FREE::Euler3DTransformController, FREE::Rigid2DTransformController, FREE::Similarity2DTransformController, FREE::VersorRigid3DTransformController, FREE::VersorTransformController, FREE::CenteredAffineTransformControllerBase< 2 >, and FREE::CenteredAffineTransformControllerBase< 3 >.

Definition at line 47 of file freMatrixOffsetTransformControllerBase.txx.

References FREE::cParam_CurrentTransformValues, FREE::cParam_InitialTransformValues, FREE::cParam_TransformScale, FREE::DASet, FREE::TransformControllerBase< TMatrixOffsetTransform, VDimension >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::MediaMap(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), FREE::Parameter::PVTDouble, and FREE::Parameter::PVTInteger.

Referenced by FREE::Euler3DTransformController::GenerateProfile(), FREE::CenteredRigid2DTransformController::GenerateProfile(), and FREE::CenteredEuler3DTransformController::GenerateProfile().

Here is the call graph for this function:

FREE::TransformControllerBase\< TMatrixOffsetTransform, VDimension \>::GenerateProfileFREE::CtrlProfile::ControllerProfileBase::MediaMapFREE::CtrlProfile::ControllerProfileBase::Parameters

template<class TMatrixOffsetTransform, unsigned int VDimension>
bool FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::SetInitialTransformValues ( ComponentType *  pTransformComponent,
SessionComponentCache *  pComponentCache,
SessionInfo *  pSessionInfo,
const int &  iInitializeByITV 
) const [inline, protected]

This version initializes the transform component of a matrix offset based transform.

Remarks:
This version only initializes the component! To ensure utilizability derived classes should use the center, translation and rotation information to set the parameter CurrentTransformationValues which will be used by registrators to initialize the transform. To remind of this the return of the function is false.
Returns:
Always false because derived classes have "some work to do".

Definition at line 92 of file freMatrixOffsetTransformControllerBase.txx.

References catchAllNPassMacro, FREE::ReferencePointsAccessor< iDimension >::FixedPointsExist(), FREE::ReferencePointsAccessor< iDimension >::GetFixedPoint(), FREE::ReferencePointsAccessor< iDimension >::GetFixedPointsCount(), FREE::TransformSetupAdaptor::GetInitialTransformParameters(), FREE::SessionAccessor::GetLinkedMedia(), FREE::ReferencePointsAccessor< iDimension >::GetMovingPoint(), FREE::ReferencePointsAccessor< iDimension >::GetMovingPointsCount(), FREE::SessionAccessor::GetParameterValue(), FREE::ReferencePointsAccessor< iDimension >::MovingPointsExist(), FREE::SessionComponentCache::Setup(), FREE::SessionComponentCache::SetupIsAssigned(), and throwCtrlExceptionMacro.

Referenced by FREE::Euler3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid2DTransformController::SetInitialTransformValues(), and FREE::CenteredEuler3DTransformController::SetInitialTransformValues().

Here is the call graph for this function:

FREE::ReferencePointsAccessor::FixedPointsExistFREE::ReferencePointsAccessor::GetFixedPointFREE::ReferencePointsAccessor::GetFixedPointsCountFREE::TransformSetupAdaptor::GetInitialTransformParametersFREE::SessionAccessor::GetLinkedMediaFREE::SessionComponentCache::SetupFREE::ReferencePointsAccessor::GetMovingPointFREE::ReferencePointsAccessor::MovingPointsExistFREE::ReferencePointsAccessor::GetMovingPointsCountFREE::SessionAccessor::GetParameterValueFREE::SessionComponentCache::SetupIsAssignedFREE::KeyedCollectionBase::GetElementFREE::SessionComponentCache::GetIDPathFREE::SessionAccessor::GetMediaFREE::IDPath::ToStrFREE::ComponentSetup::MediaLinksFREE::KeyedCollectionBase::GetElementIndexFREE::ComponentSetup::GetIDPathFREE::ComponentSetup::HasParentComponentFREE::SessionComponentCache::ControllerFREE::SessionInfo::GetCacheByIDPathFREE::ComponentControllerInterface::GetMediaFREE::IDPath::GetMediaIDFREE::IDPath::GetParentComponentIDPathFREE::IDPath::IsMediaSelectionFREE::SessionComponentCache::IsActiveFREE::IDPath::GetParentIDPathFREE::IDPath::IsComponentSelectionFREE::IDPath::IsEmptyFREE::IDPath::AssembleIDPathFREE::IDPath::SizeFREE::IDPath::SetAbsoluteFREE::IDPath::AddComponentFREE::IDPath::GetComponentFREE::IDPath::IsParameterSelectionFREE::SessionAccessor::GetParameterFREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::GetParameter

template<class TMatrixOffsetTransform, unsigned int VDimension>
void FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::CopyFixedParameters ( ComponentType *  pOrigin,
ComponentType *  pDestination 
) const [inline, protected, virtual]

This Function copies the fixed parameters from one instance of the transform to another. The default implementation is no copying at all, because a lot of transform have no fixed parameters. Setting therefore would cause an exception.

Parameters:
[in] pOrigin Pointer to transform which is source of the fixed parameters
[in,out] pDestination Pointer to the transform that should get the fixed parameters set.

Reimplemented from FREE::ITKTransformControllerBase< TMatrixOffsetTransform, VDimension >.

Definition at line 224 of file freMatrixOffsetTransformControllerBase.txx.

The documentation for this class was generated from the following files:
Generated at Sat Oct 13 18:22:12 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000