Medical Imaging Interaction Toolkit  2018.4.99-36d69b77
Medical Imaging Interaction Toolkit
mitk::MAPRegistrationWrapper Class Reference

MAPRegistrationWrapper Wrapper class to allow the handling of MatchPoint registration objects as mitk data (e.g. in the data explorer). More...

#include <mitkMAPRegistrationWrapper.h>

Inheritance diagram for mitk::MAPRegistrationWrapper:
Collaboration diagram for mitk::MAPRegistrationWrapper:

Public Types

typedef ::map::core::RegistrationBase::TagType TagType
 
typedef ::map::core::RegistrationBase::ValueType ValueType
 
typedef ::map::core::RegistrationBase::TagMapType TagMapType
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Identifiable
using UIDType = std::string
 

Public Member Functions

 mitkClassMacro (MAPRegistrationWrapper, BaseData)
 
 mitkNewMacro1Param (Self, ::map::core::RegistrationBase *)
 
Identifiable::UIDType GetUID () const override
 Get unique ID of an object. More...
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 
void SetRequestedRegion (const itk::DataObject *) override
 
virtual unsigned int GetMovingDimensions () const
 Gets the number of moving dimensions. More...
 
virtual unsigned int GetTargetDimensions () const
 Gets the number of target dimensions. More...
 
const TagMapTypeGetTags () const
 returns the tags associated with this registration More...
 
bool GetTagValue (const TagType &tag, ValueType &value) const
 returns the tag value for a specific tag More...
 
bool HasLimitedTargetRepresentation () const
 
bool HasLimitedMovingRepresentation () const
 
template<unsigned int VMovingDim, unsigned int VTargetDim>
bool MapPoint (const ::itk::Point< mitk::ScalarType, VMovingDim > &inPoint, ::itk::Point< mitk::ScalarType, VTargetDim > &outPoint) const
 
template<unsigned int VMovingDim, unsigned int VTargetDim>
bool MapPointInverse (const ::itk::Point< mitk::ScalarType, VTargetDim > &inPoint, ::itk::Point< mitk::ScalarType, VMovingDim > &outPoint) const
 
mitk::Geometry3D GetDirectFieldRepresentation () const
 
mitk::Geometry3D GetInverseFieldRepresentation () const
 
void PrecomputeDirectMapping ()
 
void PrecomputeInverseMapping ()
 
::map::core::RegistrationBase * GetRegistration ()
 
const ::map::core::RegistrationBase * GetRegistration () const
 
- Public Member Functions inherited from mitk::BaseData
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
 Get property by its key. More...
 
std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
 Query keys of existing properties. More...
 
std::vector< std::string > GetPropertyContextNames () const override
 Query names of existing contexts. More...
 
BasePropertyGetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
 Get property by its key. More...
 
void SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Add new or change existent property. More...
 
void RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Removes a property. If the property does not exist, nothing will be done. More...
 
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
virtual void Expand (unsigned int timeSteps)
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (int t=0) const
 Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information from the specified data set. More...
 
virtual bool IsInitialized () const
 Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...
 
virtual void Clear ()
 Calls ClearData() and InitializeEmpty();. More...
 
virtual bool IsEmptyTimeStep (unsigned int t) const
 Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...
 
virtual bool IsEmpty () const
 Check whether object contains data (at least at one point in time), e.g., a set of points may be empty. More...
 
void ExecuteOperation (Operation *operation) override
 overwrite if the Data can be called by an Interactor (StateMachine). More...
 
virtual void SetGeometry (BaseGeometry *aGeometry3D)
 Set the BaseGeometry of the data, which will be referenced (not copied!). Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry which saves the given BaseGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetTimeGeometry (TimeGeometry *geometry)
 Set the TimeGeometry of the data, which will be referenced (not copied!). More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D)
 Set a clone of the provided Geometry as Geometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as BaseGeometry of a given time step. More...
 
mitk::PropertyList::Pointer GetPropertyList () const
 Get the data's property list. More...
 
void SetPropertyList (PropertyList *propertyList)
 Set the data's property list. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 
virtual void SetOrigin (const Point3D &origin)
 Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...
 
itk::SmartPointer< mitk::BaseDataSourceGetSource () const
 Get the process object that generated this data object. More...
 
unsigned int GetTimeSteps () const
 Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...
 
unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 
- Public Member Functions inherited from mitk::Identifiable
 Identifiable ()
 
 Identifiable (const UIDType &uid)
 
 Identifiable (const Identifiable &)=delete
 
 Identifiable (Identifiable &&) noexcept
 
virtual ~Identifiable ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (Identifiable &&other) noexcept
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 MAPRegistrationWrapper (::map::core::RegistrationBase *registration)
 
 ~MAPRegistrationWrapper () override
 
void SetUID (const UIDType &uid) override
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData () override
 
virtual void InitializeTimeGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void InitializeTimeSlicedGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void ClearData ()
 reset to non-initialized state, release memory More...
 
virtual void InitializeEmpty ()
 Pure virtual; Must be used in subclasses to get a data object to a valid state. Should at least create one empty object and call Superclass::InitializeTimeGeometry() to ensure an existing valid geometry. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Protected Attributes

::map::core::RegistrationBase::Pointer m_spRegistration
 
- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Additional Inherited Members

- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Detailed Description

MAPRegistrationWrapper Wrapper class to allow the handling of MatchPoint registration objects as mitk data (e.g. in the data explorer).

Definition at line 36 of file mitkMAPRegistrationWrapper.h.

Member Typedef Documentation

◆ TagMapType

typedef ::map::core::RegistrationBase::TagMapType mitk::MAPRegistrationWrapper::TagMapType

Definition at line 84 of file mitkMAPRegistrationWrapper.h.

◆ TagType

typedef ::map::core::RegistrationBase::TagType mitk::MAPRegistrationWrapper::TagType

typedefs used for the TagMap

Definition at line 82 of file mitkMAPRegistrationWrapper.h.

◆ ValueType

typedef ::map::core::RegistrationBase::ValueType mitk::MAPRegistrationWrapper::ValueType

Definition at line 83 of file mitkMAPRegistrationWrapper.h.

Constructor & Destructor Documentation

◆ MAPRegistrationWrapper()

mitk::MAPRegistrationWrapper::MAPRegistrationWrapper ( ::map::core::RegistrationBase *  registration)
protected

◆ ~MAPRegistrationWrapper()

mitk::MAPRegistrationWrapper::~MAPRegistrationWrapper ( )
overrideprotected

Definition at line 28 of file mitkMAPRegistrationWrapper.cpp.

Member Function Documentation

◆ GetDirectFieldRepresentation()

mitk::Geometry3D mitk::MAPRegistrationWrapper::GetDirectFieldRepresentation ( ) const

returns the direct FieldRepresentationDescriptor which defines the part of the moving space that is guaranteed to be mapped by the direct mapping kernel. This member converts the internal MatchPoint type into a mitk::Geometry3D.

Precondition
valid registration instance must be set.
Returns
smart pointer to a FieldRepresentationDescriptor for the supported registration space in the moving domain. May be null if the direct registration kernel is global and thus not limited. If there is a limitation, the retun value is not nullptr.
Return values
nullptrno field representation set/requested by the creating registration algorithm.

◆ GetInverseFieldRepresentation()

mitk::Geometry3D mitk::MAPRegistrationWrapper::GetInverseFieldRepresentation ( ) const

returns the inverse FieldRepresentationDescriptor which defines the part of the target space that is guaranteed to be mapped by the inverse mapping kernel. This member converts the internal MatchPoint type into a mitk::Geometry3D.

Precondition
valid registration instance must be set.
Returns
a const FieldRepresentationDescriptor for the supported registration space in the target domain. May be null if the inverse registration kernel is global and thus not limited. If there is a limitation, the retun value is not nullptr.
Return values
nullptrno field representation set/requested by the creating registration algorithm.

◆ GetMovingDimensions()

unsigned int mitk::MAPRegistrationWrapper::GetMovingDimensions ( ) const
virtual

Gets the number of moving dimensions.

Precondition
valid registration instance must be set.

Definition at line 52 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration, and mitkThrow.

Referenced by mitk::MITKRegistrationHelper::is3D().

◆ GetRegistration() [1/2]

◆ GetRegistration() [2/2]

const map::core::RegistrationBase * mitk::MAPRegistrationWrapper::GetRegistration ( ) const

Definition at line 112 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration.

◆ GetTags()

const mitk::MAPRegistrationWrapper::TagMapType & mitk::MAPRegistrationWrapper::GetTags ( ) const

returns the tags associated with this registration

Precondition
valid registration instance must be set.
Returns
a TagMapType containing tags

Definition at line 71 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration, and mitkThrow.

◆ GetTagValue()

bool mitk::MAPRegistrationWrapper::GetTagValue ( const TagType tag,
ValueType value 
) const

returns the tag value for a specific tag

Precondition
valid registration instance must be set.
Returns
the success of the operation

Definition at line 80 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration, and mitkThrow.

◆ GetTargetDimensions()

unsigned int mitk::MAPRegistrationWrapper::GetTargetDimensions ( ) const
virtual

Gets the number of target dimensions.

Precondition
valid registration instance must be set.

Definition at line 62 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration, and mitkThrow.

Referenced by mitk::MITKRegistrationHelper::is3D().

◆ GetUID()

mitk::Identifiable::UIDType mitk::MAPRegistrationWrapper::GetUID ( ) const
overridevirtual

Get unique ID of an object.

Returns
Empty string if an object has no unique ID.

Reimplemented from mitk::Identifiable.

Definition at line 152 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration, and mitkThrow.

◆ HasLimitedMovingRepresentation()

bool mitk::MAPRegistrationWrapper::HasLimitedMovingRepresentation ( ) const
Precondition
valid registration instance must be set.
Returns
is the moving representation limited
Return values
trueif moving representation is limited. Thus it is not guaranteed that all direct mapping operations will succeed. Transformation(direct kernel) covers only a part of the moving space).
falseif moving representation is not limited. Thus it is guaranteed that all direct mapping operations will succeed.

Definition at line 98 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration, and mitkThrow.

◆ HasLimitedTargetRepresentation()

bool mitk::MAPRegistrationWrapper::HasLimitedTargetRepresentation ( ) const

Indicates

Precondition
valid registration instance must be set.
Returns
is the target representation limited
Return values
trueif target representation is limited. Thus it is not guaranteed that all inverse mapping operations will succeed. Transformation(inverse kernel) covers only a part of the target space).
falseif target representation is not limited. Thus it is guaranteed that all inverse mapping operations will succeed.

Definition at line 89 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration, and mitkThrow.

◆ MapPoint()

template<unsigned int VMovingDim, unsigned int VTargetDim>
bool mitk::MAPRegistrationWrapper::MapPoint ( const ::itk::Point< mitk::ScalarType, VMovingDim > &  inPoint,
::itk::Point< mitk::ScalarType, VTargetDim > &  outPoint 
) const
inline

Helper function that maps a mitk point (of arbitrary dimension) from moving space to target space.

Remarks
The operation might fail, if the moving and target dimension of the registration is not equal to the dimensionality of the passed points.
Precondition
valid registration instance must be set.
Parameters
inPointReference pointer to a MovingPointType
outPointpointer to a TargetPointType
Returns
success of operation.
Precondition
direct mapping kernel must be defined

Definition at line 128 of file mitkMAPRegistrationWrapper.h.

◆ MapPointInverse()

template<unsigned int VMovingDim, unsigned int VTargetDim>
bool mitk::MAPRegistrationWrapper::MapPointInverse ( const ::itk::Point< mitk::ScalarType, VTargetDim > &  inPoint,
::itk::Point< mitk::ScalarType, VMovingDim > &  outPoint 
) const
inline

Helper function that maps a mitk point (of arbitrary dimension) from target space to moving space

Remarks
The operation might faile, if the moving and target dimension of the registration is not equal to the dimensionalities of the passed points.
Precondition
valid registration instance must be set.
Parameters
inPointpointer to a TargetPointType
outPointpointer to a MovingPointType
Returns
success of operation

Definition at line 174 of file mitkMAPRegistrationWrapper.h.

◆ mitkClassMacro()

mitk::MAPRegistrationWrapper::mitkClassMacro ( MAPRegistrationWrapper  ,
BaseData   
)

◆ mitkNewMacro1Param()

mitk::MAPRegistrationWrapper::mitkNewMacro1Param ( Self  ,
::map::core::RegistrationBase *   
)

◆ PrecomputeDirectMapping()

void mitk::MAPRegistrationWrapper::PrecomputeDirectMapping ( )

forces kernel to precompute, even if it is a LazyFieldKernel

Precondition
valid registration instance must be set.

◆ PrecomputeInverseMapping()

void mitk::MAPRegistrationWrapper::PrecomputeInverseMapping ( )

forces kernel to precompute, even if it is a LazyFieldKernel

Precondition
valid registration instance must be set.

◆ PrintSelf()

void mitk::MAPRegistrationWrapper::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Definition at line 117 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::MAPRegistrationWrapper::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

Empty implementation, since the MAPRegistrationWrapper doesn't support the requested region concept

Implements mitk::BaseData.

Definition at line 37 of file mitkMAPRegistrationWrapper.cpp.

◆ SetRequestedRegion()

void mitk::MAPRegistrationWrapper::SetRequestedRegion ( const itk::DataObject *  )
overridevirtual

Empty implementation, since the MAPRegistrationWrapper doesn't support the requested region concept

Implements mitk::BaseData.

Definition at line 47 of file mitkMAPRegistrationWrapper.cpp.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::MAPRegistrationWrapper::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

Empty implementation, since the MAPRegistrationWrapper doesn't support the requested region concept

Implements mitk::BaseData.

Definition at line 32 of file mitkMAPRegistrationWrapper.cpp.

◆ SetUID()

void mitk::MAPRegistrationWrapper::SetUID ( const UIDType uid)
overrideprotectedvirtual

Reimplemented from mitk::Identifiable.

Definition at line 141 of file mitkMAPRegistrationWrapper.cpp.

References m_spRegistration, mitkThrow, and mitk::Identifiable::SetUID().

◆ VerifyRequestedRegion()

bool mitk::MAPRegistrationWrapper::VerifyRequestedRegion ( )
overridevirtual

Empty implementation, since the MAPRegistrationWrapper doesn't support the requested region concept

Implements mitk::BaseData.

Definition at line 42 of file mitkMAPRegistrationWrapper.cpp.

Member Data Documentation

◆ m_spRegistration

::map::core::RegistrationBase::Pointer mitk::MAPRegistrationWrapper::m_spRegistration
protected

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