Data class containing PlaneGeometry objects. More...

#include <mitkPlaneGeometryData.h>

Inheritance diagram for mitk::PlaneGeometryData:

[legend]

Collaboration diagram for mitk::PlaneGeometryData:

[legend]

Public Member Functions
	mitkClassMacro (PlaneGeometryData, GeometryData)

Pointer	Clone () const

void	SetGeometry (mitk::BaseGeometry *geometry) override
	Set the reference to a PlaneGeometry that is stored by the object. More...

virtual void	SetPlaneGeometry (mitk::PlaneGeometry *geometry2d)
	Set the reference to the PlaneGeometry that is stored by the object. More...

virtual mitk::PlaneGeometry *	GetPlaneGeometry () const
	Get the reference to the PlaneGeometry that is stored by the object. More...

void	UpdateOutputInformation () override
	Update output information from the stored geometry. More...

void	SetRequestedRegionToLargestPossibleRegion () override
	Set the requested region to the largest possible region. More...

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
	Check if the requested region is outside of the buffered region. More...

bool	VerifyRequestedRegion () override
	Verify the requested region. More...

void	SetRequestedRegion (const itk::DataObject *data) override
	Set the requested region from the given data object. More...

void	CopyInformation (const itk::DataObject *data) override
	Copy information from the given data object. More...

Public Member Functions inherited from mitk::GeometryData
	mitkClassMacro (GeometryData, BaseData)

Pointer	Clone () const

void	UpdateOutputInformation () override
	Update the output information. More...

void	CopyInformation (const itk::DataObject *data) override
	Copy information from another data object. More...

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	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 ()

Static Public Member Functions inherited from mitk::GeometryData
static Pointer	New ()

Protected Member Functions
	PlaneGeometryData ()

	~PlaneGeometryData () override

Protected Member Functions inherited from mitk::GeometryData
	GeometryData ()

	~GeometryData () 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)

Additional Inherited Members
Public Types inherited from mitk::Identifiable
using	UIDType = std::string
	Type alias for unique identifiers. More...

Protected Attributes inherited from mitk::BaseData
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Detailed Description

Data class containing PlaneGeometry objects.

Wraps a PlaneGeometry as a GeometryData so it can be stored in a DataNode and managed by the DataStorage.

See also: PlaneGeometry; GeometryData

Definition at line 33 of file mitkPlaneGeometryData.h.

Constructor & Destructor Documentation

◆ PlaneGeometryData()

mitk::PlaneGeometryData::PlaneGeometryData ( )

protected

◆ ~PlaneGeometryData()

mitk::PlaneGeometryData::~PlaneGeometryData ( )

overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::PlaneGeometryData::Clone ( ) const

◆ CopyInformation()

void mitk::PlaneGeometryData::CopyInformation ( const itk::DataObject * data )

override

Copy information from the given data object.

◆ GetPlaneGeometry()

virtual mitk::PlaneGeometry* mitk::PlaneGeometryData::GetPlaneGeometry ( ) const

inlinevirtual

Get the reference to the PlaneGeometry that is stored by the object.

Returns: Pointer to the stored PlaneGeometry, or nullptr if none is set.

Definition at line 62 of file mitkPlaneGeometryData.h.

◆ mitkClassMacro()

mitk::PlaneGeometryData::mitkClassMacro	(	PlaneGeometryData	,
		GeometryData
	)

◆ New()

static Pointer mitk::PlaneGeometryData::New ( )

static

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::PlaneGeometryData::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

Check if the requested region is outside of the buffered region.

Returns: true if no PlaneGeometry is set, false otherwise.

Reimplemented from mitk::GeometryData.

◆ SetGeometry()

void mitk::PlaneGeometryData::SetGeometry ( mitk::BaseGeometry * geometry )

overridevirtual

Set the reference to a PlaneGeometry that is stored by the object.

Warning: Accepts only instances of PlaneGeometry or sub-classes. Throws an exception if a non-PlaneGeometry is passed.

Parameters

geometry The geometry to store. Must be a PlaneGeometry.

Reimplemented from mitk::BaseData.

◆ SetPlaneGeometry()

virtual void mitk::PlaneGeometryData::SetPlaneGeometry ( mitk::PlaneGeometry * geometry2d )

virtual

Set the reference to the PlaneGeometry that is stored by the object.

Parameters

geometry2d The PlaneGeometry to store.

◆ SetRequestedRegion()

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

overridevirtual

Set the requested region from the given data object.

Reimplemented from mitk::GeometryData.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::PlaneGeometryData::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

Set the requested region to the largest possible region.

Reimplemented from mitk::GeometryData.

◆ UpdateOutputInformation()

void mitk::PlaneGeometryData::UpdateOutputInformation ( )

override

Update output information from the stored geometry.

◆ VerifyRequestedRegion()

bool mitk::PlaneGeometryData::VerifyRequestedRegion ( )

overridevirtual

Verify the requested region.

Returns: false if no PlaneGeometry is set, true otherwise.

Reimplemented from mitk::GeometryData.

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

mitkPlaneGeometryData.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlaneGeometryData()

◆ ~PlaneGeometryData()

Member Function Documentation

◆ Clone()

◆ CopyInformation()

◆ GetPlaneGeometry()

◆ mitkClassMacro()

◆ New()

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

◆ SetGeometry()

◆ SetPlaneGeometry()

◆ SetRequestedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

◆ UpdateOutputInformation()

◆ VerifyRequestedRegion()