Medical Imaging Interaction Toolkit  2018.4.99-b585543d
Medical Imaging Interaction Toolkit
mitk::RegEvaluationObject Class Reference

RegEvaluationObject Class that containes all data to realize an evaluation of registrations via images. More...

#include <mitkRegEvaluationObject.h>

Inheritance diagram for mitk::RegEvaluationObject:
Collaboration diagram for mitk::RegEvaluationObject:

Public Member Functions

 mitkClassMacro (RegEvaluationObject, BaseData)
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 
void SetRequestedRegion (const itk::DataObject *) override
 
virtual void SetRegistration (mitk::MAPRegistrationWrapper *_arg)
 
void SetTargetImage (const mitk::Image *tImg)
 
void SetMovingImage (const mitk::Image *mImg)
 
virtual mitk::MAPRegistrationWrapperGetRegistration ()
 
virtual mitk::ImageGetTargetImage ()
 
virtual mitk::ImageGetMovingImage ()
 
virtual const mitk::MAPRegistrationWrapperGetRegistration ()
 
virtual const mitk::ImageGetTargetImage ()
 
virtual const mitk::ImageGetMovingImage ()
 
void SetTargetNode (const mitk::DataNode *tNode)
 
void SetMovingNode (const mitk::DataNode *mNode)
 
virtual const mitk::DataNodeGetTargetNode ()
 
virtual const mitk::DataNodeGetMovingNode ()
 
- 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
 
UIDType GetUID () const
 Get unique ID of an object. More...
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 

Static Public Member Functions

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

Protected Types

typedef ::itk::Image< unsigned char, 3 > InternalImageType
 

Protected Member Functions

template<typename TPixelType , unsigned int VImageDimension>
void doConversion (const ::itk::Image< TPixelType, VImageDimension > *input, mitk::Image::Pointer &result) const
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 RegEvaluationObject ()
 
 ~RegEvaluationObject () 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

mitk::MAPRegistrationWrapper::Pointer m_Registration
 
mitk::Image::Pointer m_TargetImage
 
mitk::Image::Pointer m_MovingImage
 
mitk::DataNode::ConstPointer m_TargetNode
 
mitk::DataNode::ConstPointer m_MovingNode
 
- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Additional Inherited Members

- 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
 

Detailed Description

RegEvaluationObject Class that containes all data to realize an evaluation of registrations via images.

Definition at line 36 of file mitkRegEvaluationObject.h.

Member Typedef Documentation

◆ InternalImageType

typedef ::itk::Image<unsigned char, 3> mitk::RegEvaluationObject::InternalImageType
protected

Definition at line 85 of file mitkRegEvaluationObject.h.

Constructor & Destructor Documentation

◆ RegEvaluationObject()

mitk::RegEvaluationObject::RegEvaluationObject ( )
protected

Definition at line 26 of file mitkRegEvaluationObject.cpp.

◆ ~RegEvaluationObject()

mitk::RegEvaluationObject::~RegEvaluationObject ( )
overrideprotected

Definition at line 30 of file mitkRegEvaluationObject.cpp.

Member Function Documentation

◆ doConversion()

template<typename TPixelType , unsigned int VImageDimension>
void mitk::RegEvaluationObject::doConversion ( const ::itk::Image< TPixelType, VImageDimension > *  input,
mitk::Image::Pointer result 
) const
protected

Definition at line 101 of file mitkRegEvaluationObject.cpp.

References max(), and min().

Referenced by SetMovingImage(), and SetTargetImage().

◆ GetMovingImage() [1/2]

virtual mitk::Image* mitk::RegEvaluationObject::GetMovingImage ( )
virtual

◆ GetMovingImage() [2/2]

virtual const mitk::Image* mitk::RegEvaluationObject::GetMovingImage ( )
virtual

◆ GetMovingNode()

virtual const mitk::DataNode* mitk::RegEvaluationObject::GetMovingNode ( )
virtual

◆ GetRegistration() [1/2]

virtual mitk::MAPRegistrationWrapper* mitk::RegEvaluationObject::GetRegistration ( )
virtual

◆ GetRegistration() [2/2]

virtual const mitk::MAPRegistrationWrapper* mitk::RegEvaluationObject::GetRegistration ( )
virtual

◆ GetTargetImage() [1/2]

virtual mitk::Image* mitk::RegEvaluationObject::GetTargetImage ( )
virtual

◆ GetTargetImage() [2/2]

virtual const mitk::Image* mitk::RegEvaluationObject::GetTargetImage ( )
virtual

◆ GetTargetNode()

virtual const mitk::DataNode* mitk::RegEvaluationObject::GetTargetNode ( )
virtual

◆ mitkClassMacro()

mitk::RegEvaluationObject::mitkClassMacro ( RegEvaluationObject  ,
BaseData   
)

◆ New()

static Pointer mitk::RegEvaluationObject::New ( )
static

◆ PrintSelf()

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

Definition at line 122 of file mitkRegEvaluationObject.cpp.

References m_MovingImage, m_Registration, and m_TargetImage.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::RegEvaluationObject::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

Pass through to the target image that defines the region

Implements mitk::BaseData.

Definition at line 39 of file mitkRegEvaluationObject.cpp.

◆ SetMovingImage()

void mitk::RegEvaluationObject::SetMovingImage ( const mitk::Image mImg)

takes the input image, rescales it and converts it to pixel type int to be used for visualization as mapped moving

Definition at line 91 of file mitkRegEvaluationObject.cpp.

References AccessFixedDimensionByItk_n, doConversion(), and m_MovingImage.

◆ SetMovingNode()

void mitk::RegEvaluationObject::SetMovingNode ( const mitk::DataNode mNode)

takes the input image, rescales it and converts it to pixel type int to be used for visualization as mapped moving

Definition at line 68 of file mitkRegEvaluationObject.cpp.

References mitk::DataNode::GetData(), m_MovingImage, and m_MovingNode.

◆ SetRegistration()

virtual void mitk::RegEvaluationObject::SetRegistration ( mitk::MAPRegistrationWrapper _arg)
virtual

◆ SetRequestedRegion()

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

Pass through to the target image that defines the region

Implements mitk::BaseData.

Definition at line 49 of file mitkRegEvaluationObject.cpp.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::RegEvaluationObject::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

Pass through to the target image that defines the region

Implements mitk::BaseData.

Definition at line 34 of file mitkRegEvaluationObject.cpp.

◆ SetTargetImage()

void mitk::RegEvaluationObject::SetTargetImage ( const mitk::Image tImg)

takes the input image, rescales it and converts it to pixel type int to be used for visualization as target image

Definition at line 82 of file mitkRegEvaluationObject.cpp.

References AccessFixedDimensionByItk_n, doConversion(), and m_TargetImage.

◆ SetTargetNode()

void mitk::RegEvaluationObject::SetTargetNode ( const mitk::DataNode tNode)

takes the input image, rescales it and converts it to pixel type int to be used for visualization as target image

Definition at line 54 of file mitkRegEvaluationObject.cpp.

References mitk::DataNode::GetData(), m_TargetImage, and m_TargetNode.

◆ VerifyRequestedRegion()

bool mitk::RegEvaluationObject::VerifyRequestedRegion ( )
overridevirtual

Pass through to the target image that defines the region

Implements mitk::BaseData.

Definition at line 44 of file mitkRegEvaluationObject.cpp.

Member Data Documentation

◆ m_MovingImage

mitk::Image::Pointer mitk::RegEvaluationObject::m_MovingImage
protected

Definition at line 100 of file mitkRegEvaluationObject.h.

Referenced by PrintSelf(), SetMovingImage(), and SetMovingNode().

◆ m_MovingNode

mitk::DataNode::ConstPointer mitk::RegEvaluationObject::m_MovingNode
protected

Definition at line 102 of file mitkRegEvaluationObject.h.

Referenced by SetMovingNode().

◆ m_Registration

mitk::MAPRegistrationWrapper::Pointer mitk::RegEvaluationObject::m_Registration
protected

Definition at line 98 of file mitkRegEvaluationObject.h.

Referenced by PrintSelf().

◆ m_TargetImage

mitk::Image::Pointer mitk::RegEvaluationObject::m_TargetImage
protected

Definition at line 99 of file mitkRegEvaluationObject.h.

Referenced by PrintSelf(), SetTargetImage(), and SetTargetNode().

◆ m_TargetNode

mitk::DataNode::ConstPointer mitk::RegEvaluationObject::m_TargetNode
protected

Definition at line 101 of file mitkRegEvaluationObject.h.

Referenced by SetTargetNode().


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