Data container holding all information needed for visual evaluation of a registration. More...

#include <mitkRegEvaluationObject.h>

Inheritance diagram for mitk::RegEvaluationObject:

[legend]

Collaboration diagram for mitk::RegEvaluationObject:

[legend]

Public Member Functions
	mitkClassMacro (RegEvaluationObject, BaseData)

void	SetRequestedRegionToLargestPossibleRegion () override
	Passes through to the target image that defines the region. More...

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
	Passes through to the target image that defines the region. More...

bool	VerifyRequestedRegion () override
	Passes through to the target image that defines the region. More...

void	SetRequestedRegion (const itk::DataObject *data) override
	Passes through to the target image that defines the region. More...

virtual void	SetRegistration (mitk::MAPRegistrationWrapper *_arg)

void	SetTargetImage (const mitk::Image *tImg)
	Sets the target image for evaluation. More...

void	SetMovingImage (const mitk::Image *mImg)
	Sets the moving image for evaluation. More...

virtual mitk::MAPRegistrationWrapper *	GetRegistration ()

virtual mitk::Image *	GetTargetImage ()

virtual mitk::Image *	GetMovingImage ()

virtual const mitk::MAPRegistrationWrapper *	GetRegistration ()

virtual const mitk::Image *	GetTargetImage ()

virtual const mitk::Image *	GetMovingImage ()

void	SetTargetNode (const mitk::DataNode *tNode)
	Sets the target data node reference for property access during rendering. More...

void	SetMovingNode (const mitk::DataNode *mNode)
	Sets the moving data node reference for property access during rendering. More...

virtual const mitk::DataNode *	GetTargetNode ()

virtual const mitk::DataNode *	GetMovingNode ()

Public Member Functions inherited from mitk::BaseData
	mitkClassMacroItkParent (BaseData, itk::DataObject)

BaseProperty::ConstPointer	GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
	Get a const property by its key. More...

std::vector< std::string >	GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
	Get all property keys stored in the property list. More...

std::vector< std::string >	GetPropertyContextNames () const override
	Get the names of all property contexts. More...

BaseProperty *	GetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
	Get a non-const property by its key. More...

void	SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
	Set a property in the property list. More...

void	RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
	Remove a property from the property list. More...

const mitk::TimeGeometry *	GetTimeGeometry () const
	Return the TimeGeometry of the data as const pointer. More...

mitk::TimeGeometry *	GetTimeGeometry ()
	Return the TimeGeometry of the data as non-const pointer. More...

const mitk::TimeGeometry *	GetUpdatedTimeGeometry ()
	Return the TimeGeometry of the data after ensuring it is up-to-date. More...

virtual void	Expand (unsigned int timeSteps)
	Expand the TimeGeometry to a number of time steps. More...

const mitk::BaseGeometry *	GetUpdatedGeometry (int t=0)
	Return the BaseGeometry of the data at time step t after ensuring it is up-to-date. More...

mitk::BaseGeometry *	GetGeometry (int t=0) const
	Return the BaseGeometry of the data at time step t as a non-const pointer. More...

void	UpdateOutputInformation () override
	Update the information for this BaseData 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. More...

virtual void	Clear ()
	Reset the data object by calling ClearData() and InitializeEmpty(). More...

virtual bool	IsEmptyTimeStep (unsigned int t) const
	Check whether the object contains data at the specified time step. More...

virtual bool	IsEmpty () const
	Check whether the object contains data at any time step. More...

void	ExecuteOperation (Operation *operation) override
	Execute an operation on this data object. More...

virtual void	SetGeometry (BaseGeometry *aGeometry3D)
	Set the BaseGeometry of the data, which will be referenced (not copied!). 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 the BaseGeometry of the data. More...

virtual void	SetClonedTimeGeometry (const TimeGeometry *geometry)
	Set a clone of the provided TimeGeometry as the TimeGeometry of the data. More...

virtual void	SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
	Set a clone of the provided geometry as the 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, replacing the existing one. More...

mitk::BaseProperty::Pointer	GetProperty (const char *propertyKey) const
	Get a property by its key from the PropertyList. More...

void	SetProperty (const char propertyKey, BaseProperty property)
	Set a property in the PropertyList. More...

virtual void	SetOrigin (const Point3D &origin)
	Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...

itk::SmartPointer< mitk::BaseDataSource >	GetSource () const
	Get the process object that generated this data object. More...

unsigned int	GetTimeSteps () const
	Get the number of time steps from the TimeGeometry. More...

itk::ModifiedTimeType	GetMTime () const override
	Get the modification time of this data object or its geometry, whichever was modified most recently. More...

void	Graft (const DataObject *) override
	Graft data and information from another data object. More...

Public Member Functions inherited from mitk::OperationActor
	itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()

Public Member Functions inherited from mitk::Identifiable
	Identifiable ()
	Default constructor. Generates a new random UID. More...

	Identifiable (const UIDType &uid)
	Construct with a pre-existing UID. More...

	Identifiable (const Identifiable &)=delete
	Copy construction is deleted to prevent UID duplication. More...

	Identifiable (Identifiable &&) noexcept
	Move constructor. Transfers ownership of the UID. More...

virtual	~Identifiable ()
	Virtual destructor. More...

Identifiable &	operator= (const Identifiable &)=delete
	Copy assignment is deleted to prevent UID duplication. More...

Identifiable &	operator= (Identifiable &&other) noexcept
	Move assignment operator. Transfers ownership of the UID. More...

virtual UIDType	GetUID () const
	Get the unique identifier of this object. More...

UIDType	GetRuntimeUID () const noexcept
	Get a runtime-unique ID for this object instance. More...

Public Member Functions inherited from mitk::IPropertyOwner
	~IPropertyOwner () override

virtual bool	PropertyIsOwned (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const
	Checks if a certain property exists. More...

Public Member Functions inherited from mitk::IPropertyProvider
virtual	~IPropertyProvider ()
	Virtual destructor. More...

Static Public Member Functions
static Pointer	New ()

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	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 Member Functions inherited from mitk::Identifiable
virtual void	SetUID (const UIDType &uid)

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::Identifiable
using	UIDType = std::string
	Type alias for unique identifiers. More...

Detailed Description

Data container holding all information needed for visual evaluation of a registration.

RegEvaluationObject bundles a registration together with rescaled target and moving images (converted to unsigned char pixel type) for use by the RegEvaluationMapper2D. It also stores references to the original data nodes for property lookup during rendering.

See also: mitk::RegEvaluationMapper2D, mitk::RegEvalStyleProperty, mitk::MAPRegistrationWrapper

Definition at line 41 of file mitkRegEvaluationObject.h.

Member Typedef Documentation

◆ InternalImageType

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

protected

Definition at line 116 of file mitkRegEvaluationObject.h.

Constructor & Destructor Documentation

◆ RegEvaluationObject()

mitk::RegEvaluationObject::RegEvaluationObject ( )

protected

◆ ~RegEvaluationObject()

mitk::RegEvaluationObject::~RegEvaluationObject ( )

overrideprotected

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

◆ 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

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::RegEvaluationObject::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

Passes through to the target image that defines the region.

Returns: True if the requested region is outside the buffered region.

Implements mitk::BaseData.

◆ SetMovingImage()

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

Sets the moving image for evaluation.

The input image is rescaled and converted to unsigned char pixel type for visualization.

Parameters

[in] mImg Pointer to the moving image.

◆ SetMovingNode()

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

Sets the moving data node reference for property access during rendering.

Parameters

[in] mNode Pointer to the moving data node.

◆ SetRegistration()

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

virtual

◆ SetRequestedRegion()

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

overridevirtual

Passes through to the target image that defines the region.

Parameters

[in] data The data object from which to copy the requested region.

Implements mitk::BaseData.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::RegEvaluationObject::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

Passes through to the target image that defines the region.

Implements mitk::BaseData.

◆ SetTargetImage()

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

Sets the target image for evaluation.

The input image is rescaled and converted to unsigned char pixel type for visualization.

Parameters

[in] tImg Pointer to the target image.

◆ SetTargetNode()

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

Sets the target data node reference for property access during rendering.

Parameters

[in] tNode Pointer to the target data node.

◆ VerifyRequestedRegion()

bool mitk::RegEvaluationObject::VerifyRequestedRegion ( )

overridevirtual

Passes through to the target image that defines the region.

Returns: True if the requested region is valid.

Implements mitk::BaseData.

Member Data Documentation

◆ m_MovingImage

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

protected

Definition at line 128 of file mitkRegEvaluationObject.h.

◆ m_MovingNode

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

protected

Definition at line 130 of file mitkRegEvaluationObject.h.

◆ m_Registration

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

protected

Definition at line 126 of file mitkRegEvaluationObject.h.

◆ m_TargetImage

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

protected

Definition at line 127 of file mitkRegEvaluationObject.h.

◆ m_TargetNode

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

protected

Definition at line 129 of file mitkRegEvaluationObject.h.

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

mitkRegEvaluationObject.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InternalImageType

Constructor & Destructor Documentation

◆ RegEvaluationObject()

◆ ~RegEvaluationObject()

Member Function Documentation

◆ doConversion()

◆ GetMovingImage() [1/2]

◆ GetMovingImage() [2/2]

◆ GetMovingNode()

◆ GetRegistration() [1/2]

◆ GetRegistration() [2/2]

◆ GetTargetImage() [1/2]

◆ GetTargetImage() [2/2]

◆ GetTargetNode()

◆ mitkClassMacro()

◆ New()

◆ PrintSelf()

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

◆ SetMovingImage()

◆ SetMovingNode()

◆ SetRegistration()

◆ SetRequestedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

◆ SetTargetImage()

◆ SetTargetNode()

◆ VerifyRequestedRegion()

Member Data Documentation

◆ m_MovingImage

◆ m_MovingNode

◆ m_Registration

◆ m_TargetImage

◆ m_TargetNode