Base of all data objects. More...

#include <mitkBaseData.h>

Inheritance diagram for mitk::BaseData:

Collaboration diagram for mitk::BaseData:

Public Types
typedef BaseData	Self

typedef itk::DataObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const

virtual const char *	GetClassName () const

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

const mitk::TimeGeometry *	GetTimeSlicedGeometry () 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...

const mitk::TimeGeometry *	GetUpdatedTimeSliceGeometry ()
	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...

virtual void	SetRequestedRegionToLargestPossibleRegion () override=0
	Set the RequestedRegion to the LargestPossibleRegion. More...

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

virtual 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...

virtual 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 TimeGeometry as TimeGeometry 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...

virtual unsigned long	GetMTime () const override
	Get the modified time of the last change of the contents this data object or its geometry. More...

virtual void	Graft (const DataObject *) override

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

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	BaseData ()

	BaseData (const BaseData &other)

	~BaseData ()

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...

virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const override

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

Definition at line 39 of file mitkBaseData.h.

Member Typedef Documentation

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

Definition at line 42 of file mitkBaseData.h.

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

Definition at line 42 of file mitkBaseData.h.

typedef BaseData mitk::BaseData::Self

Definition at line 42 of file mitkBaseData.h.

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

Definition at line 42 of file mitkBaseData.h.

Constructor & Destructor Documentation

mitk::BaseData::BaseData ( )

protected

Definition at line 24 of file mitkBaseData.cpp.

References mitk::ProportionalTimeGeometry::New(), and mitk::PropertyList::New().

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

protected

Definition at line 30 of file mitkBaseData.cpp.

mitk::BaseData::~BaseData ( )

protected

Definition at line 40 of file mitkBaseData.cpp.

Member Function Documentation

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, mitk::DataCollection, mitk::UndirectedGraph< TVertex, TEdge >, mitk::UndirectedGraph< TubeGraphVertex, TubeGraphEdge >, and mitk::ContourModelSet.

Definition at line 248 of file mitkBaseData.cpp.

Referenced by mitk::SinglePointDataInteractor::DataNodeChanged(), QmitkFiducialRegistrationWidget::Register(), and mitk::DataNode::SetData().

void mitk::BaseData::ClearData ( )

protectedvirtual

reset to non-initialized state, release memory

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

Definition at line 254 of file mitkBaseData.cpp.

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.

Definition at line 223 of file mitkBaseData.cpp.

References mitk::TimeGeometry::Clone(), GetPropertyList(), and GetTimeGeometry().

void mitk::BaseData::ExecuteOperation ( mitk::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, mitk::Mesh, and mitk::Surface.

Definition at line 263 of file mitkBaseData.cpp.

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::Image, mitk::ContourModel, mitk::PointSet, mitk::UnstructuredGrid, and mitk::Surface.

Definition at line 84 of file mitkBaseData.cpp.

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

inlinevirtual

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

Definition at line 42 of file mitkBaseData.h.

Referenced by mitk::FileWriterSelector::FileWriterSelector(), and mitk::FileWriterRegistry::GetReferences().

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

virtual

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

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 129 of file mitkBaseData.h.

Referenced by mitk::Gizmo::AddGizmoToNode(), mitk::PlanarFigureInteractor::AddInitialPoint(), addPlaneToDataStorage(), mitk::PlanarFigureInteractor::AddPoint(), mitk::BoundingObject::BoundingObject(), mitk::PlanarFigureInteractor::CheckControlPointHovering(), mitk::PlanarFigureInteractor::CheckFigureHovering(), mitk::PlanarFigureInteractor::CheckFigureOnRenderingGeometry(), mitk::AffineImageCropperInteractor::CheckOverObject(), mitk::PythonService::CopyToPythonAsSimpleItkImage(), TrackVisFiberReader::create(), mitk::BoundingShapeCropper::CutImage(), mitk::SegTool2D::DetermineAffectedImageSlice(), mitk::CollectionDilation::DilateBinaryByName(), mitk::TimeFramesRegistrationHelper::DoFrameMapping(), mitk::TestDCMLoading::DumpImageInformation(), mitk::Equal(), mitk::CollectionDilation::ErodeBinaryByName(), mitk::DiffSliceOperationApplier::ExecuteOperation(), mitk::PartialVolumeAnalysisHistogramCalculator::ExtractImageAndMask(), mitk::ImageStatisticsCalculator::ExtractImageAndMask(), mitk::DicomSeriesReader::FixSpacingInformation(), mitk::ImageToUnstructuredGridFilter::GenerateData(), mitk::ImageToIGTLMessageFilter::GenerateData(), mitk::ExtractImageFilter::GenerateData(), mitk::HeightFieldSurfaceClipImageFilter::GenerateData(), mitk::NavigationDataObjectVisualizationFilter::GenerateData(), mitk::BoundingShapeVtkMapper3D::GenerateDataForRenderer(), mitk::LabelSetImageVtkMapper2D::GenerateDataForRenderer(), mitk::ImageVtkMapper2D::GenerateDataForRenderer(), mitk::DoseImageVtkMapper2D::GenerateDataForRenderer(), mitk::HeightFieldSurfaceClipImageFilter::GenerateOutputInformation(), mitk::ImagePixelWriteAccessor< TPixel, VDimension >::GetPixelByWorldCoordinates(), mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetPixelByWorldCoordinates(), mitk::SurfaceVtkIO::GetPolyData(), mitk::ItkImageIO::GetWriterConfidenceLevel(), mitk::PlanarFigureInteractor::IsMousePositionAcceptableAsNewControlPoint(), mitk::LiveWireTool2D::IsPositionEventInsideImageRegion(), main(), MeshUtil< MeshType, ScalarAccessor >::MeshFromSurface(), mitkPlaneGeometryDataMapper2DTest(), mitk::PlanarFigureInteractor::MoveCurrentPoint(), mitk::PickingTool::OnPointAdded(), QmitkAdaptiveRegionGrowingToolGUI::OnPointAdded(), mitk::ContourModelUtils::ProjectContourTo2DSlice(), QmitkAdaptiveRegionGrowingToolGUI::RunSegmentation(), mitk::PlanarFigureInteractor::SelectPoint(), QmitkSlicesInterpolator::SetCurrentContourListID(), mitk::CompressedImageContainer::SetImage(), mitk::GizmoInteractor::SetManipulatedObjectNode(), testGeometryDataToSurfaceFilter(), testSurfaceBoundingBoxConsistency(), mitk::TubeGraphIO::Write(), mitk::ItkImageIO::Write(), and mitk::ImageWriter::WriteByITK().

unsigned long mitk::BaseData::GetMTime ( ) const

overridevirtual

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

Reimplemented in mitk::ExtrudedContour.

Definition at line 204 of file mitkBaseData.cpp.

Referenced by mitk::ConnectomicsHistogramCache::operator[](), mitk::SimpleHistogramCache::operator[](), mitk::PointLocator::SetPoints(), and mitk::LabelSetImageVtkMapper2D::Update().

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

Definition at line 172 of file mitkBaseData.cpp.

Referenced by mitk::NodePredicateDataProperty::CheckNode(), mitk::CheckUID(), mitk::EnsureUID(), mitk::DWIHeadMotionCorrectionFilter::GenerateData(), mitk::DiffusionPropertyHelper::GetBValueMap(), mitk::DiffusionPropertyHelper::GetGradientContainer(), mitk::DiffusionPropertyHelper::GetMeasurementFrame(), mitk::DiffusionPropertyHelper::GetOriginalGradientContainer(), mitk::DiffusionPropertyHelper::GetReferenceBValue(), mitk::RegistrationWrapper::GetTransformation(), mitk::DiffusionPropertyHelper::IsDiffusionWeightedImage(), mitk::AbstractFileReader::SetDefaultDataNodeProperties(), mitk::SimulationIO::Write(), and mitk::TubeGraphIO::Write().

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

Get the data's property list.

See also: GetProperty; m_PropertyList

Definition at line 167 of file mitkBaseData.cpp.

Referenced by mitk::PlanarFigureInteractor::CheckFigurePlaced(), CopyInformation(), mitk::SurfaceToImageFilter::GenerateOutputInformation(), mitk::HeightFieldSurfaceClipImageFilter::GenerateOutputInformation(), mitk::GetPropertyByDICOMTagPath(), mitk::AbstractClassifier::SetNthItems(), mitk::VigraRandomForestClassifier::VigraRandomForestClassifier(), and mitk::ItkImageIO::Write().

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.

Definition at line 162 of file mitkBaseData.cpp.

Referenced by mitk::UndirectedGraph< TubeGraphVertex, TubeGraphEdge >::UpdateOutputInformation().

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

inlinestatic

Definition at line 42 of file mitkBaseData.h.

Referenced by mitk::PlanarFigureWriter::GetSupportedBaseData().

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 52 of file mitkBaseData.h.

Referenced by mitk::ContourModelUtils::BackProjectContourFrom2DSlice(), mitk::BoundingObject::BoundingObject(), mitk::LiveWireTool2D::ConfirmSegmentation(), CopyInformation(), mitk::Tool::CreateEmptySegmentationNode(), mitk::TestDCMLoading::DumpImageInformation(), mitk::TestDICOMLoading::DumpImageInformation(), mitk::Equal(), mitk::ManualSegmentationToSurfaceFilter::GenerateData(), mitk::ExtractDirectedPlaneImageFilter::GenerateData(), mitk::HeightFieldSurfaceClipImageFilter::GenerateData(), mitk::SurfaceVtkMapper2D::GenerateDataForRenderer(), mitk::LabelSetImageVtkMapper2D::GenerateDataForRenderer(), mitk::ImageVtkMapper2D::GenerateDataForRenderer(), mitk::DoseImageVtkMapper2D::GenerateDataForRenderer(), mitk::MaskImageFilter::GenerateInputRequestedRegion(), mitk::SurfaceToImageFilter::GenerateOutputInformation(), mitk::LabeledImageToSurfaceFilter::GenerateOutputInformation(), mitk::SegTool2D::GetAffectedImageSliceAs2DImage(), mitk::SurfaceVtkIO::GetPolyData(), mitk::BaseRenderer::GetTimeStep(), mitk::Image::Image(), mitk::LabelSetImage::Initialize(), mitk::Image::Initialize(), mitk::ContourModel::Initialize(), mitk::ImageMappingHelper::map(), QmitkSlicesInterpolator::OnAcceptInterpolationClicked(), mitk::ContourModelUtils::ProjectContourTo2DSlice(), mitk::ContourModelMapper2D::Update(), mitk::ContourModelMapper3D::Update(), mitk::LabelSetImageVtkMapper2D::Update(), mitk::RegEvaluationMapper2D::Update(), mitk::Mapper::Update(), mitk::ImageVtkMapper2D::Update(), mitk::DoseImageVtkMapper2D::Update(), mitk::SurfaceVtkMapper2D::Update(), mitk::SurfaceStlIO::Write(), mitk::SurfaceVtkXmlIO::Write(), mitk::SurfaceVtkLegacyIO::Write(), mitk::ItkImageIO::Write(), mitk::GeometryDataWriterService::Write(), and mitk::ContourModelWriter::WriteXML().

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 76 of file mitkBaseData.h.

const mitk::TimeGeometry* mitk::BaseData::GetTimeSlicedGeometry ( ) 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.

Deprecated:: (as of 2013_09) Please use GetTimeGeometry instead: For additional information see http://www.mitk.org/Development/Refactoring%20of%20the%20Geometry%20Classes%20-%20Part%201

Definition at line 67 of file mitkBaseData.h.

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 346 of file mitkBaseData.h.

Referenced by mitk::ContourModelToSurfaceFilter::GenerateData(), mitk::SurfaceInterpolationController::GetContour(), mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetPixelByWorldCoordinates(), mitk::ImageMappingHelper::map(), mitk::ContourModelLiveWireInteractor::OnDeletePoint(), mitk::ContourModelLiveWireInteractor::OnMovePoint(), mitk::ImageStatisticsCalculator::SetImage(), mitk::PartialVolumeAnalysisHistogramCalculator::SetImageMask(), QmitkPointListView::wheelEvent(), mitk::ContourModelWriter::WriteXML(), and mitk::PointSetWriter::WriteXML().

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

Definition at line 96 of file mitkBaseData.cpp.

Referenced by mitk::PartialVolumeAnalysisHistogramCalculator::ExtractImageAndMask().

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

Definition at line 75 of file mitkBaseData.cpp.

Referenced by mitk::VectorImageMapper2D::GetCurrentTimeStep().

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

inline

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

Deprecated:: (as of 2013_09) Please use GetUpdatedTimeGeometry instead: For additional information see http://www.mitk.org/Development/Refactoring%20of%20the%20Geometry%20Classes%20-%20Part%201

Definition at line 97 of file mitkBaseData.h.

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

overridevirtual

See also: itk::ProcessObject::Graft

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

Definition at line 218 of file mitkBaseData.cpp.

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 388 of file mitkBaseData.h.

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.

Definition at line 44 of file mitkBaseData.cpp.

References mitk::Geometry3D::New().

Referenced by mitk::ContourModelSet::ContourModelSet(), and mitk::BaseDataTestImplementation::InitializeTimeGeometry().

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

inlineprotectedvirtual

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.

Deprecated:: (as of 2013_09) Please use GetUpdatedTimeGeometry instead: For additional information see http://www.mitk.org/Development/Refactoring%20of%20the%20Geometry%20Classes%20-%20Part%201

Definition at line 375 of file mitkBaseData.h.

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::ContourModel, mitk::AbstractClassifier, mitk::NavigationDataSet, mitk::ContourModelSet, and mitk::AbstractGlobalImageFeature.

Definition at line 146 of file mitkBaseData.cpp.

Referenced by mitk::SimpleImageHistogram::ComputeFromBaseData(), mitk::IOUtil::Save(), and mitk::ToFCompositeFilter::SetInput().

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, and mitk::Surface.

Definition at line 141 of file mitkBaseData.cpp.

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.

Definition at line 243 of file mitkBaseData.cpp.

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

overrideprotectedvirtual

Reimplemented in mitk::Image, mitk::PlanarFigure, mitk::PointSet, mitk::MAPRegistrationWrapper, mitk::Contour, mitk::PlanarCross, mitk::RegEvaluationObject, mitk::PlanarEllipse, mitk::PlanarCircle, mitk::PlanarPolygon, mitk::PlanarArrow, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarAngle, mitk::PlanarRectangle, and mitk::Surface.

Definition at line 268 of file mitkBaseData.cpp.

virtual 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::PointSet, mitk::PlanarFigure, mitk::AbstractClassifier, mitk::NavigationDataSet, mitk::Contour, mitk::ManufacturerLogo, mitk::ContourModelSet, mitk::SlicedData, mitk::UndirectedGraph< TVertex, TEdge >, mitk::UndirectedGraph< TubeGraphVertex, TubeGraphEdge >, mitk::VtkWidgetRendering, mitk::ConnectomicsNetwork, mitk::ContourSet, mitk::PlaneGeometryData, mitk::DataCollection, mitk::AbstractGlobalImageFeature, mitk::MAPRegistrationWrapper, mitk::RegEvaluationObject, mitk::FiberBundle, mitk::Surface, mitk::UnstructuredGrid, mitk::BaseDataTestImplementation, mitk::PlanarFigureComposite, mitk::Simulation, mitk::GeometryData, mitk::FiberBundleThreadMonitor, and mitk::ExampleDataStructure.

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

virtual

Set a clone of the provided TimeGeometry as TimeGeometry 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

Definition at line 122 of file mitkBaseData.cpp.

References mitk::BaseGeometry::Clone().

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

Definition at line 133 of file mitkBaseData.cpp.

References mitk::BaseGeometry::Clone().

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

virtual

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

See also: SetGeometry

Definition at line 127 of file mitkBaseData.cpp.

References mitk::TimeGeometry::Clone().

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::Image, mitk::SlicedData, and mitk::PlaneGeometryData.

Definition at line 105 of file mitkBaseData.cpp.

References mitk::ProportionalTimeGeometry::New().

Referenced by mitk::ExampleDataStructure::ExampleDataStructure(), and mitk::PlanarFigureComposite::PlanarFigureComposite().

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.

Definition at line 187 of file mitkBaseData.cpp.

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

Definition at line 177 of file mitkBaseData.cpp.

Referenced by mitk::DicomSeriesReader::CopyMetaDataToImageProperties(), mitk::EnsureUID(), mitk::PlanarFigureInteractor::FinalizeFigure(), mitk::PlanarCircle::PlanarCircle(), mitk::PlanarCross::PlanarCross(), mitk::PlanarDoubleEllipse::PlanarDoubleEllipse(), mitk::PlanarEllipse::PlanarEllipse(), mitk::PlanarFigure::PlanarFigure(), mitk::PlanarPolygon::PlanarPolygon(), mitk::PlanarRectangle::PlanarRectangle(), mitk::PlanarSubdivisionPolygon::PlanarSubdivisionPolygon(), and mitk::QBallImage::QBallImage().

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

Set the data's property list.

See also: SetProperty; m_PropertyList

Definition at line 182 of file mitkBaseData.cpp.

Referenced by mitk::HeightFieldSurfaceClipImageFilter::GenerateOutputInformation().

virtual 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::AbstractClassifier, mitk::NavigationDataSet, mitk::Contour, mitk::ManufacturerLogo, mitk::SlicedData, mitk::VtkWidgetRendering, mitk::ContourModelSet, mitk::UndirectedGraph< TVertex, TEdge >, mitk::UndirectedGraph< TubeGraphVertex, TubeGraphEdge >, mitk::ContourSet, mitk::ConnectomicsNetwork, mitk::PlaneGeometryData, mitk::MAPRegistrationWrapper, mitk::DataCollection, mitk::RegEvaluationObject, mitk::AbstractGlobalImageFeature, mitk::FiberBundle, mitk::UnstructuredGrid, mitk::Surface, mitk::BaseDataTestImplementation, mitk::PlanarFigureComposite, mitk::Simulation, mitk::GeometryData, mitk::FiberBundleThreadMonitor, and mitk::ExampleDataStructure.

virtual 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::PointSet, mitk::PlanarFigure, mitk::AbstractClassifier, mitk::NavigationDataSet, mitk::Contour, mitk::ManufacturerLogo, mitk::ContourModelSet, mitk::UndirectedGraph< TVertex, TEdge >, mitk::UndirectedGraph< TubeGraphVertex, TubeGraphEdge >, mitk::ConnectomicsNetwork, mitk::SlicedData, mitk::VtkWidgetRendering, mitk::ContourSet, mitk::DataCollection, mitk::PlaneGeometryData, mitk::AbstractGlobalImageFeature, mitk::Surface, mitk::FiberBundle, mitk::MAPRegistrationWrapper, mitk::RegEvaluationObject, mitk::BaseDataTestImplementation, mitk::UnstructuredGrid, mitk::Simulation, mitk::PlanarFigureComposite, mitk::FiberBundleThreadMonitor, mitk::GeometryData, and mitk::ExampleDataStructure.

Referenced by testGeometryDataToSurfaceFilter().

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

Definition at line 116 of file mitkBaseData.cpp.

Referenced by mitk::BoundingObjectGroup::BoundingObjectGroup(), mitk::ContourSet::ContourSet(), mitk::ExtrudedContour::ExtrudedContour(), and mitk::Image::Image().

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

Definition at line 63 of file mitkBaseData.cpp.

virtual 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::PointSet, mitk::PlanarFigure, mitk::AbstractClassifier, mitk::NavigationDataSet, mitk::Contour, mitk::ManufacturerLogo, mitk::SlicedData, mitk::ContourModelSet, mitk::UndirectedGraph< TVertex, TEdge >, mitk::UndirectedGraph< TubeGraphVertex, TubeGraphEdge >, mitk::VtkWidgetRendering, mitk::ContourSet, mitk::ConnectomicsNetwork, mitk::PlaneGeometryData, mitk::DataCollection, mitk::MAPRegistrationWrapper, mitk::RegEvaluationObject, mitk::AbstractGlobalImageFeature, mitk::Surface, mitk::BoundingObjectGroup, mitk::FiberBundle, mitk::UnstructuredGrid, mitk::Simulation, mitk::PlanarFigureComposite, mitk::BaseDataTestImplementation, mitk::GeometryData, mitk::FiberBundleThreadMonitor, and mitk::ExampleDataStructure.

Member Data Documentation

bool mitk::BaseData::m_Initialized

protected

Definition at line 395 of file mitkBaseData.h.

Referenced by mitk::Image::Image(), and mitk::UnstructuredGrid::UnstructuredGrid().

bool mitk::BaseData::m_LastRequestedRegionWasOutsideOfTheBufferedRegion

protected

Definition at line 391 of file mitkBaseData.h.

unsigned int mitk::BaseData::m_SourceOutputIndexDuplicate

mutableprotected

Definition at line 393 of file mitkBaseData.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation