Base of all data objects. More...

#include <mitkBaseData.h>

Inheritance diagram for mitk::BaseData:

[legend]

Collaboration diagram for mitk::BaseData:

[legend]

Public Types
typedef BaseData	Self

typedef itk::DataObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::Identifiable
using	UIDType = std::string

Public Member Functions
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...

BaseProperty *	GetNonConstProperty (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::TimeGeometry *	GetTimeGeometry () const
	Return the TimeGeometry of the data as const pointer. More...

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

const mitk::TimeGeometry *	GetUpdatedTimeGeometry ()
	Return the TimeGeometry of the data. More...

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

const mitk::BaseGeometry *	GetUpdatedGeometry (int t=0)
	Return the BaseGeometry of the data at time t. More...

mitk::BaseGeometry *	GetGeometry (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	SetRequestedRegionToLargestPossibleRegion () override=0
	Set the RequestedRegion to the LargestPossibleRegion. More...

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override=0
	Determine whether the RequestedRegion is outside of the BufferedRegion. More...

bool	VerifyRequestedRegion () override=0
	Verify that the RequestedRegion is within the LargestPossibleRegion. 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	SetRequestedRegion (const itk::DataObject *data) override=0
	Set the requested region from this data object to match the requested region of the data object passed in as a parameter. 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::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 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...

itk::ModifiedTimeType	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 ()

Identifiable &	operator= (const Identifiable &)=delete

Identifiable &	operator= (Identifiable &&other) noexcept

virtual 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 const char *	GetStaticNameOfClass ()

Protected Member Functions
	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
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Detailed Description

Base of all data objects.

Base of all data objects, e.g., images, contours, surfaces etc. Inherits from itk::DataObject and thus can be included in a pipeline. Inherits also from OperationActor and can be used as a destination for Undo

Remarks: Some derived classes may support the persistence of the Identifiable UID.

Definition at line 42 of file mitkBaseData.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> mitk::BaseData::ConstPointer

Definition at line 46 of file mitkBaseData.h.

◆ Pointer

typedef itk::SmartPointer<Self> mitk::BaseData::Pointer

Definition at line 46 of file mitkBaseData.h.

◆ Self

typedef BaseData mitk::BaseData::Self

Definition at line 46 of file mitkBaseData.h.

◆ Superclass

typedef itk::DataObject mitk::BaseData::Superclass

Definition at line 46 of file mitkBaseData.h.

Constructor & Destructor Documentation

◆ BaseData() [1/2]

mitk::BaseData::BaseData ( )

protected

◆ BaseData() [2/2]

mitk::BaseData::BaseData ( const BaseData & other )

protected

◆ ~BaseData()

mitk::BaseData::~BaseData ( )

overrideprotected

Member Function Documentation

◆ Clear()

virtual void mitk::BaseData::Clear ( )

virtual

Calls ClearData() and InitializeEmpty();.

Warning: Only use in subclasses that reimplemented these methods. Just calling Clear from BaseData will reset an object to a not initialized, invalid state.

Reimplemented in mitk::Image, mitk::ContourModel, and mitk::ContourModelSet.

◆ ClearData()

virtual void mitk::BaseData::ClearData ( )

protectedvirtual

reset to non-initialized state, release memory

Reimplemented in mitk::ContourModel, mitk::PointSet, mitk::UnstructuredGrid, and mitk::Surface.

◆ CopyInformation()

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

override

Copy information from the specified data set.

This method is part of the pipeline execution model. By default, a BaseProcess will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from another DataObject. The default implementation of this method copies the time sliced geometry and the property list of an object. If a subclass overrides this method, it should always call its superclass' version.

◆ ExecuteOperation()

void mitk::BaseData::ExecuteOperation ( Operation * operation )

overridevirtual

overwrite if the Data can be called by an Interactor (StateMachine).

Empty by default. Overwrite and implement all the necessary operations here and get the necessary information from the parameter operation.

Implements mitk::OperationActor.

Reimplemented in mitk::PointSet, and mitk::Surface.

◆ Expand()

virtual void mitk::BaseData::Expand ( unsigned int timeSteps )

virtual

Expands the TimeGeometry to a number of TimeSteps.

The method expands the TimeGeometry to the given number of TimeSteps, filling newly created elements with empty geometries. Sub-classes should override this method to handle the elongation of their data vectors, too. Note that a shrinking is neither possible nor intended.

Reimplemented in mitk::UnstructuredGrid, mitk::Surface, mitk::Image, mitk::ContourModel, and mitk::PointSet.

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::BaseData::GetClassHierarchy ( ) const

inlinevirtual

Reimplemented in mitk::Image, mitk::PointSet, mitk::VtkWidgetRendering, mitk::SlicedData, mitk::PlaneGeometryData, mitk::Surface, mitk::BaseDataTestImplementation, mitk::GeometryData, and mitk::CrosshairData.

Definition at line 46 of file mitkBaseData.h.

◆ GetClassName()

virtual const char* mitk::BaseData::GetClassName ( ) const

virtual

Reimplemented in mitk::Image, mitk::PointSet, mitk::VtkWidgetRendering, mitk::SlicedData, mitk::PlaneGeometryData, mitk::Surface, mitk::BaseDataTestImplementation, mitk::GeometryData, and mitk::CrosshairData.

◆ GetConstProperty()

BaseProperty::ConstPointer mitk::BaseData::GetConstProperty	(	const std::string &	propertyKey,
		const std::string &	contextName = `""`,
		bool	fallBackOnDefaultContext = `true`
	)		const

overridevirtual

Get property by its key.

Parameters

[in]	propertyKey	Key of property.
[in]	contextName	Optional, default is empty string (default context). Search in specified context.
[in]	fallBackOnDefaultContext	Optional, default is true. Also search in default context if property was not found in given context.

Returns: Found property, nullptr otherwise.

Implements mitk::IPropertyProvider.

◆ GetGeometry()

mitk::BaseGeometry* mitk::BaseData::GetGeometry ( int t = 0 ) const

inline

Return the geometry, which is a TimeGeometry, of the data as non-const pointer.

Warning: No update will be called. Use GetUpdatedGeometry() if you cannot be sure that the geometry is up-to-date.

Normally used in GenerateOutputInformation of subclasses of BaseProcess.

Definition at line 121 of file mitkBaseData.h.

Referenced by mitk::ImagePixelWriteAccessor< TPixel, VDimension >::GetPixelByWorldCoordinates(), and mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetPixelByWorldCoordinates().

◆ GetMTime()

itk::ModifiedTimeType mitk::BaseData::GetMTime ( ) const

override

Get the modified time of the last change of the contents this data object or its geometry.

◆ GetNonConstProperty()

BaseProperty* mitk::BaseData::GetNonConstProperty	(	const std::string &	propertyKey,
		const std::string &	contextName = `""`,
		bool	fallBackOnDefaultContext = `true`
	)

overridevirtual

Get property by its key.

Parameters

[in]	propertyKey	Key of property.
[in]	contextName	Optional, default is empty string (default context). Search in specified context.
[in]	fallBackOnDefaultContext	Optional, default is true. Also search in default context if property was not found in given context.

Returns: Found property, nullptr otherwise.

Implements mitk::IPropertyOwner.

◆ GetProperty()

mitk::BaseProperty::Pointer mitk::BaseData::GetProperty ( const char * propertyKey ) const

Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;.

See also: GetPropertyList; m_PropertyList; m_MapOfPropertyLists

◆ GetPropertyContextNames()

std::vector<std::string> mitk::BaseData::GetPropertyContextNames ( ) const

overridevirtual

Query names of existing contexts.

Returns: List of context names.

Implements mitk::IPropertyProvider.

◆ GetPropertyKeys()

std::vector<std::string> mitk::BaseData::GetPropertyKeys	(	const std::string &	contextName = `""`,
		bool	includeDefaultContext = `false`
	)		const

overridevirtual

Query keys of existing properties.

Parameters

[in]	contextName	Optional, default is empty string (default context). Search in specified context.
[in]	includeDefaultContext	Optional, default is false. Include default context.

Returns: List of property keys.

Implements mitk::IPropertyProvider.

◆ GetPropertyList()

mitk::PropertyList::Pointer mitk::BaseData::GetPropertyList ( ) const

Get the data's property list.

See also: GetProperty; m_PropertyList

◆ GetSource()

itk::SmartPointer<mitk::BaseDataSource> mitk::BaseData::GetSource ( ) const

Get the process object that generated this data object.

If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointer and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

◆ GetStaticNameOfClass()

static const char* mitk::BaseData::GetStaticNameOfClass ( )

inlinestatic

Definition at line 46 of file mitkBaseData.h.

◆ GetTimeGeometry() [1/2]

mitk::TimeGeometry* mitk::BaseData::GetTimeGeometry ( )

inline

Return the TimeGeometry of the data as pointer.

Warning: No update will be called. Use GetUpdatedGeometry() if you cannot be sure that the geometry is up-to-date.

Normally used in GenerateOutputInformation of subclasses of BaseProcess.

Definition at line 79 of file mitkBaseData.h.

◆ GetTimeGeometry() [2/2]

const mitk::TimeGeometry* mitk::BaseData::GetTimeGeometry ( ) const

inline

Return the TimeGeometry of the data as const pointer.

Warning: No update will be called. Use GetUpdatedGeometry() if you cannot be sure that the geometry is up-to-date.

Normally used in GenerateOutputInformation of subclasses of BaseProcess.

Definition at line 66 of file mitkBaseData.h.

◆ GetTimeSteps()

unsigned int mitk::BaseData::GetTimeSteps ( ) const

inline

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.

Definition at line 338 of file mitkBaseData.h.

Referenced by mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetPixelByWorldCoordinates().

◆ GetUpdatedGeometry()

const mitk::BaseGeometry* mitk::BaseData::GetUpdatedGeometry ( int t = 0 )

Return the BaseGeometry of the data at time t.

The method does not simply return m_TimeGeometry->GetGeometry(t). Before doing this, it makes sure that the BaseGeometry is up-to-date (by setting the update extent appropriately and calling UpdateOutputInformation).

◆ GetUpdatedTimeGeometry()

const mitk::TimeGeometry* mitk::BaseData::GetUpdatedTimeGeometry ( )

Return the TimeGeometry of the data.

The method does not simply return the value of the m_TimeGeometry member. Before doing this, it makes sure that the TimeGeometry is up-to-date (by setting the update extent to largest possible and calling UpdateOutputInformation).

◆ Graft()

void mitk::BaseData::Graft ( const DataObject * )

override

See also: itk::ProcessObject::Graft

◆ InitializeEmpty()

virtual void mitk::BaseData::InitializeEmpty ( )

inlineprotectedvirtual

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.

Reimplemented in mitk::ContourModel, mitk::PointSet, mitk::ContourModelSet, mitk::UnstructuredGrid, and mitk::Surface.

Definition at line 368 of file mitkBaseData.h.

◆ InitializeTimeGeometry()

virtual void mitk::BaseData::InitializeTimeGeometry ( unsigned int timeSteps = 1 )

protectedvirtual

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.

Reimplemented in mitk::PlanarFigure, and mitk::BaseDataTestImplementation.

Referenced by mitk::BaseDataTestImplementation::InitializeTimeGeometry().

◆ IsEmpty()

virtual bool mitk::BaseData::IsEmpty ( ) const

virtual

Check whether object contains data (at least at one point in time), e.g., a set of points may be empty.

Warning: Returns IsInitialized()==false by default for compatibility reasons. Override in sub-classes that support distinction between empty/non-empty state.

Reimplemented in mitk::AbstractGlobalImageFeature, mitk::ContourModel, mitk::AbstractClassifier, mitk::IntensityQuantifier, mitk::ContourModelSet, and mitk::MAPRegistrationWrapper.

◆ IsEmptyTimeStep()

virtual bool mitk::BaseData::IsEmptyTimeStep ( unsigned int t ) const

virtual

Check whether object contains data (at a specified time), e.g., a set of points may be empty.

Warning: Returns IsInitialized()==false by default for compatibility reasons. Override in sub-classes that support distinction between empty/non-empty state.

Reimplemented in mitk::ContourModel, mitk::PointSet, mitk::Surface, and mitk::MAPRegistrationWrapper.

◆ IsInitialized()

virtual bool mitk::BaseData::IsInitialized ( ) const

virtual

Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set.

Warning: Set to true by default for compatibility reasons. Set m_Initialized=false in constructors of sub-classes that support distinction between initialized and uninitialized state.

◆ PrintSelf()

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

overrideprotected

◆ RemoveProperty()

void mitk::BaseData::RemoveProperty	(	const std::string &	propertyKey,
		const std::string &	contextName = `""`,
		bool	fallBackOnDefaultContext = `false`
	)

overridevirtual

Removes a property. If the property does not exist, nothing will be done.

Parameters

[in]	propertyKey	Key of property.
[in]	contextName	Optional, default is empty string (default context). Context in which the property is removed.
[in]	fallBackOnDefaultContext	Optional, default is false. Remove property in default context if given context does not exist.

Precondition: If a context is specified by contextName, this context must be known by the owner or fallBackOnDefaultContext must be true. If violated an mitk::Exception is thrown.; propertyKey must be a none empty string. If violated an mitk::Exception is thrown.

Implements mitk::IPropertyOwner.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::BaseData::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridepure virtual

Determine whether the RequestedRegion is outside of the BufferedRegion.

This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Implemented in mitk::ContourModel, mitk::AbstractGlobalImageFeature, mitk::PointSet, mitk::PlanarFigure, mitk::ROI, mitk::AbstractClassifier, mitk::Contour, mitk::SegmentationTaskList, mitk::ContourModelSet, mitk::SlicedData, mitk::VtkWidgetRendering, mitk::ContourSet, mitk::PlaneGeometryData, mitk::IntensityQuantifier, mitk::MAPRegistrationWrapper, mitk::RegEvaluationObject, mitk::Surface, mitk::UnstructuredGrid, mitk::ImageStatisticsContainer, mitk::BaseDataTestImplementation, mitk::GeometryData, mitk::ExampleDataStructure, and mitk::CrosshairData.

◆ SetClonedGeometry() [1/2]

virtual void mitk::BaseData::SetClonedGeometry ( const BaseGeometry * aGeometry3D )

virtual

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.

See also: SetGeometry

◆ SetClonedGeometry() [2/2]

virtual void mitk::BaseData::SetClonedGeometry	(	const BaseGeometry *	aGeometry3D,
		unsigned int	time
	)

virtual

Set a clone of the provided geometry as BaseGeometry of a given time step.

See also: SetGeometry

◆ SetClonedTimeGeometry()

virtual void mitk::BaseData::SetClonedTimeGeometry ( const TimeGeometry * geometry )

virtual

Set a clone of the provided TimeGeometry as TimeGeometry of the data.

See also: SetGeometry

◆ SetGeometry()

virtual void mitk::BaseData::SetGeometry ( BaseGeometry * aGeometry3D )

virtual

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.

Warning: This method will normally be called internally by the sub-class of BaseData during initialization.

See also: SetClonedGeometry

Reimplemented in mitk::PlaneGeometryData, mitk::Image, and mitk::SlicedData.

◆ SetOrigin()

virtual void mitk::BaseData::SetOrigin ( const Point3D & origin )

virtual

Convenience method for setting the origin of the BaseGeometry instances of all time steps.

Warning: Geometries contained in the BaseGeometry will not be changed, e.g. in case the BaseGeometry is a SlicedGeometry3D the origin will not be propagated to the contained slices. The sub-class SlicedData does this for the case that the SlicedGeometry3D is evenly spaced.

Reimplemented in mitk::SlicedData.

◆ SetProperty() [1/2]

void mitk::BaseData::SetProperty	(	const char *	propertyKey,
		BaseProperty *	property
	)

◆ SetProperty() [2/2]

void mitk::BaseData::SetProperty	(	const std::string &	propertyKey,
		BaseProperty *	property,
		const std::string &	contextName = `""`,
		bool	fallBackOnDefaultContext = `false`
	)

overridevirtual

Add new or change existent property.

Parameters

[in]	propertyKey	Key of property.
[in]	property	The actual property.
[in]	contextName	Optional, default is empty string (default context). Context in which the property is set.
[in]	fallBackOnDefaultContext	Optional, default is false. Set property in default context if given context does not exist.

Precondition: If a context is specified by contextName, this context must be known by the owner or fallBackOnDefaultContext must be true. If violated an mitk::Exception is thrown.; propertyKey must be a none empty string. If violated an mitk::Exception is thrown.

Implements mitk::IPropertyOwner.

◆ SetPropertyList()

void mitk::BaseData::SetPropertyList ( PropertyList * propertyList )

Set the data's property list.

See also: SetProperty; m_PropertyList

◆ SetRequestedRegion()

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

overridepure virtual

Set the requested region from this data object to match the requested region of the data object passed in as a parameter.

This method is implemented in the concrete subclasses of BaseData.

Implemented in mitk::ContourModel, mitk::PointSet, mitk::PlanarFigure, mitk::ROI, mitk::Contour, mitk::SlicedData, mitk::ContourSet, mitk::PlaneGeometryData, mitk::UnstructuredGrid, mitk::Surface, mitk::GeometryData, mitk::CrosshairData, mitk::AbstractGlobalImageFeature, mitk::AbstractClassifier, mitk::SegmentationTaskList, mitk::VtkWidgetRendering, mitk::ContourModelSet, mitk::MAPRegistrationWrapper, mitk::IntensityQuantifier, mitk::RegEvaluationObject, mitk::ImageStatisticsContainer, mitk::BaseDataTestImplementation, and mitk::ExampleDataStructure.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::BaseData::SetRequestedRegionToLargestPossibleRegion ( )

overridepure virtual

Set the RequestedRegion to the LargestPossibleRegion.

This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Implemented in mitk::ContourModel, mitk::AbstractGlobalImageFeature, mitk::PointSet, mitk::PlanarFigure, mitk::ROI, mitk::AbstractClassifier, mitk::Contour, mitk::SegmentationTaskList, mitk::ContourModelSet, mitk::SlicedData, mitk::VtkWidgetRendering, mitk::ContourSet, mitk::IntensityQuantifier, mitk::PlaneGeometryData, mitk::MAPRegistrationWrapper, mitk::Surface, mitk::RegEvaluationObject, mitk::BaseDataTestImplementation, mitk::UnstructuredGrid, mitk::ImageStatisticsContainer, mitk::GeometryData, mitk::ExampleDataStructure, and mitk::CrosshairData.

◆ SetTimeGeometry()

virtual void mitk::BaseData::SetTimeGeometry ( TimeGeometry * geometry )

virtual

Set the TimeGeometry of the data, which will be referenced (not copied!).

Warning: This method will normally be called internally by the sub-class of BaseData during initialization.

See also: SetClonedTimeGeometry

◆ UpdateOutputInformation()

void mitk::BaseData::UpdateOutputInformation ( )

override

Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess.

This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a BaseData. Any implementation of this method in a derived class is assumed to call its source's BaseProcess::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Default implementation simply call's it's source's UpdateOutputInformation().

Note: Implementations of this methods in derived classes must take care that the geometry is updated by calling GetTimeGeometry()->UpdateInformation() after calling its source's BaseProcess::UpdateOutputInformation().

◆ VerifyRequestedRegion()

bool mitk::BaseData::VerifyRequestedRegion ( )

overridepure virtual

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion.

Implemented in mitk::ContourModel, mitk::AbstractGlobalImageFeature, mitk::PointSet, mitk::PlanarFigure, mitk::ROI, mitk::AbstractClassifier, mitk::Contour, mitk::SegmentationTaskList, mitk::SlicedData, mitk::ContourModelSet, mitk::VtkWidgetRendering, mitk::ContourSet, mitk::PlaneGeometryData, mitk::IntensityQuantifier, mitk::MAPRegistrationWrapper, mitk::RegEvaluationObject, mitk::Surface, mitk::BoundingObjectGroup, mitk::UnstructuredGrid, mitk::ImageStatisticsContainer, mitk::BaseDataTestImplementation, mitk::GeometryData, mitk::ExampleDataStructure, and mitk::CrosshairData.

Member Data Documentation

◆ m_Initialized

bool mitk::BaseData::m_Initialized

protected

Definition at line 375 of file mitkBaseData.h.

◆ m_LastRequestedRegionWasOutsideOfTheBufferedRegion

bool mitk::BaseData::m_LastRequestedRegionWasOutsideOfTheBufferedRegion

protected

Definition at line 371 of file mitkBaseData.h.

◆ m_SourceOutputIndexDuplicate

unsigned int mitk::BaseData::m_SourceOutputIndexDuplicate

mutableprotected

Definition at line 373 of file mitkBaseData.h.

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

mitkBaseData.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ BaseData() [1/2]

◆ BaseData() [2/2]

◆ ~BaseData()

Member Function Documentation

◆ Clear()

◆ ClearData()

◆ CopyInformation()

◆ ExecuteOperation()

◆ Expand()

◆ GetClassHierarchy()

◆ GetClassName()

◆ GetConstProperty()

◆ GetGeometry()

◆ GetMTime()

◆ GetNonConstProperty()

◆ GetProperty()

◆ GetPropertyContextNames()

◆ GetPropertyKeys()

◆ GetPropertyList()

◆ GetSource()

◆ GetStaticNameOfClass()

◆ GetTimeGeometry() [1/2]

◆ GetTimeGeometry() [2/2]

◆ GetTimeSteps()

◆ GetUpdatedGeometry()

◆ GetUpdatedTimeGeometry()

◆ Graft()

◆ InitializeEmpty()

◆ InitializeTimeGeometry()

◆ IsEmpty()

◆ IsEmptyTimeStep()

◆ IsInitialized()

◆ PrintSelf()

◆ RemoveProperty()

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

◆ SetClonedGeometry() [1/2]

◆ SetClonedGeometry() [2/2]

◆ SetClonedTimeGeometry()

◆ SetGeometry()

◆ SetOrigin()

◆ SetProperty() [1/2]

◆ SetProperty() [2/2]

◆ SetPropertyList()

◆ SetRequestedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

◆ SetTimeGeometry()

◆ UpdateOutputInformation()

◆ VerifyRequestedRegion()

Member Data Documentation

◆ m_Initialized

◆ m_LastRequestedRegionWasOutsideOfTheBufferedRegion

◆ m_SourceOutputIndexDuplicate