Class for storing surfaces (vtkPolyData). More...

#include <mitkSurface.h>

Inheritance diagram for mitk::Surface:

Collaboration diagram for mitk::Surface:

Public Types
typedef itk::ImageRegion< 5 >	RegionType

typedef Surface	Self

typedef BaseData	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::BaseData
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 override

virtual const char *	GetClassName () const

Pointer	Clone () const

void	CalculateBoundingBox ()

virtual void	CopyInformation (const itk::DataObject *data) override

virtual void	ExecuteOperation (Operation *operation) override
	overwrite if the Data can be called by an Interactor (StateMachine). More...

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

const RegionType &	GetLargestPossibleRegion () const

virtual const RegionType &	GetRequestedRegion () const

unsigned int	GetSizeOfPolyDataSeries () const

virtual vtkPolyData *	GetVtkPolyData (unsigned int t=0) const

virtual void	Graft (const DataObject *data) override

virtual bool	IsEmptyTimeStep (unsigned int t) const override
	Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...

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

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

virtual void	SetRequestedRegion (const itk::DataObject *data) override
	Set the requested region from this data object to match the requested region of the data object passed in as a parameter. More...

virtual void	SetRequestedRegion (Surface::RegionType *region)

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

virtual void	SetVtkPolyData (vtkPolyData *polydata, unsigned int t=0)

virtual void	Swap (Surface &other)

virtual void	Update () override

virtual void	UpdateOutputInformation () override

virtual bool	VerifyRequestedRegion () override
	Verify that the RequestedRegion is within the LargestPossibleRegion. More...

Public Member Functions inherited from mitk::BaseData
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...

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

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

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

static Pointer	New ()

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

Protected Member Functions
virtual itk::LightObject::Pointer	InternalClone () const override

	Surface ()

virtual	~Surface ()

	Surface (const Surface &other)

Surface &	operator= (Surface other)

virtual void	ClearData () override
	reset to non-initialized state, release memory More...

virtual void	InitializeEmpty () override
	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...

Protected Member Functions inherited from mitk::BaseData
	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...

Additional Inherited Members
Protected Attributes inherited from mitk::BaseData
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Detailed Description

Class for storing surfaces (vtkPolyData).

Definition at line 32 of file mitkSurface.h.

Member Typedef Documentation

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

Definition at line 37 of file mitkSurface.h.

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

Definition at line 37 of file mitkSurface.h.

typedef itk::ImageRegion<5> mitk::Surface::RegionType

Definition at line 35 of file mitkSurface.h.

typedef Surface mitk::Surface::Self

Definition at line 37 of file mitkSurface.h.

typedef BaseData mitk::Surface::Superclass

Definition at line 37 of file mitkSurface.h.

Constructor & Destructor Documentation

mitk::Surface::Surface ( )

protected

Definition at line 41 of file mitkSurface.cpp.

References InitializeEmpty().

mitk::Surface::~Surface ( )

protectedvirtual

Definition at line 77 of file mitkSurface.cpp.

mitk::Surface::Surface ( const Surface & other )

protected

Definition at line 46 of file mitkSurface.cpp.

References DeepCopy(), and InitializeEmpty().

Member Function Documentation

void mitk::Surface::CalculateBoundingBox ( )

Definition at line 175 of file mitkSurface.cpp.

References mitk::TimeGeometry::GetGeometryForTimeStep(), mitkThrow, and mitk::TimeGeometry::Update().

void mitk::Surface::ClearData ( )

overrideprotectedvirtual

reset to non-initialized state, release memory

Reimplemented from mitk::BaseData.

Definition at line 82 of file mitkSurface.cpp.

Pointer mitk::Surface::Clone ( ) const

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

overridevirtual

Definition at line 254 of file mitkSurface.cpp.

References GetLargestPossibleRegion(), and mitkThrow.

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

Reimplemented from mitk::BaseData.

Definition at line 287 of file mitkSurface.cpp.

References mitk::Operation::GetOperationType(), mitk::SurfaceOperation::GetTimeStep(), mitk::SurfaceOperation::GetVtkPolyData(), and mitk::OpSURFACECHANGED.

void mitk::Surface::Expand ( unsigned int timeSteps = 1 )

overridevirtual

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 from mitk::BaseData.

Definition at line 276 of file mitkSurface.cpp.

Referenced by mitk::ContourModelToSurfaceFilter::GenerateData().

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

inlineoverridevirtual

Reimplemented from mitk::BaseData.

Definition at line 37 of file mitkSurface.h.

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

virtual

Reimplemented from mitk::BaseData.

const mitk::Surface::RegionType & mitk::Surface::GetLargestPossibleRegion ( ) const

Definition at line 89 of file mitkSurface.cpp.

Referenced by CopyInformation().

const mitk::Surface::RegionType & mitk::Surface::GetRequestedRegion ( ) const

virtual

Definition at line 97 of file mitkSurface.cpp.

Referenced by SetRequestedRegion().

unsigned int mitk::Surface::GetSizeOfPolyDataSeries ( ) const

Definition at line 320 of file mitkSurface.cpp.

Referenced by mitk::Equal(), and Graft().

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

inlinestatic

Definition at line 37 of file mitkSurface.h.

Referenced by mitk::SurfaceVtkWriter< VTKWRITER >::GetSupportedBaseData(), and mitk::BaseDataCompare::RegisterCoreEquals().

vtkPolyData * mitk::Surface::GetVtkPolyData ( unsigned int t = 0 ) const

virtual

Definition at line 145 of file mitkSurface.cpp.

Referenced by mitk::PythonService::CopyToPythonAsVtkPolyData(), mitk::Equal(), mitk::ComputeContourSetNormalsFilter::GenerateData(), mitk::ReduceContourSetFilter::GenerateData(), mitk::HeightFieldSurfaceClipImageFilter::GenerateData(), mitk::PlaneGeometryDataVtkMapper3D::GenerateDataForRenderer(), mitk::SurfaceVtkMapper2D::GenerateDataForRenderer(), mitk::ComputeContourSetNormalsFilter::GetNormalsAsSurface(), mitk::SurfaceVtkIO::GetPolyData(), MeshUtil< MeshType, ScalarAccessor >::MeshFromSurface(), mitk::PlaneGeometryDataVtkMapper3D::ProcessNode(), and testSurfaceBoundingBoxConsistency().

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

overridevirtual

See also: itk::ProcessObject::Graft

Reimplemented from mitk::BaseData.

Definition at line 325 of file mitkSurface.cpp.

References GetSizeOfPolyDataSeries(), mitkThrow, and mitk::New().

void mitk::Surface::InitializeEmpty ( )

overrideprotectedvirtual

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 from mitk::BaseData.

Definition at line 102 of file mitkSurface.cpp.

Referenced by Surface().

virtual itk::LightObject::Pointer mitk::Surface::InternalClone ( ) const

inlineoverrideprotectedvirtual

Definition at line 62 of file mitkSurface.h.

bool mitk::Surface::IsEmptyTimeStep ( unsigned int t ) const

overridevirtual

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 from mitk::BaseData.

Definition at line 134 of file mitkSurface.cpp.

static Pointer mitk::Surface::New ( )

static

Examples:: Step7.cpp.

Referenced by mitk::ComputeContourSetNormalsFilter::ComputeContourSetNormalsFilter(), mitk::ContourModelToSurfaceFilter::ContourModelToSurfaceFilter(), mitk::PythonService::CopyVtkPolyDataFromPython(), mitk::PlanarFigureSegmentationController::CreateSurfaceFromPlanarFigure(), mitk::ContourModelUtils::FillContourInSlice(), mitk::ReduceContourSetFilter::GenerateData(), QmitkODFRenderWidget::GenerateODF(), mitk::KinectV2Device::GetAllImages(), mitk::ComputeContourSetNormalsFilter::GetNormalsAsSurface(), QmitkToFSurfaceGenerationWidget::Initialize(), mitk::SurfaceBasedInterpolationController::Initialize(), mitk::SurfaceInterpolationController::Interpolate(), mitk::ExtrudePlanarFigureFilter::MakeOutput(), mitk::SurfaceSource::MakeOutput(), mitkPropertySerializationTest(), mitkSimpleHistogramTest(), mitkSurfaceTest(), mitkSurfaceToSurfaceFilterTest(), mitkSurfaceVtkMapper3DTexturedSphereTest(), mitkSurfaceVtkWriterTest(), QmitkNavigationToolCreationWidget::OnFinished(), mitk::SurfaceStlIO::Read(), mitk::SurfaceVtkXmlIO::Read(), mitk::SurfaceVtkLegacyIO::Read(), mitk::ReduceContourSetFilter::ReduceContourSetFilter(), mitk::SurfaceInterpolationController::ReinitializeInterpolation(), mitk::ComputeContourSetNormalsFilter::Reset(), mitk::ReduceContourSetFilter::Reset(), mitk::VtkModel::SetMode(), QmitkNavigationToolCreationAdvancedWidget::SetToolTipSurface(), Step7::StartRegionGrowing(), mitk::SurfaceInterpolationController::SurfaceInterpolationController(), and TestDataStorage().

mitk::Surface & mitk::Surface::operator= ( Surface other )

protected

Definition at line 71 of file mitkSurface.cpp.

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

overridevirtual

Reimplemented from mitk::BaseData.

Definition at line 342 of file mitkSurface.cpp.

bool mitk::Surface::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

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

Implements mitk::BaseData.

Definition at line 211 of file mitkSurface.cpp.

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

overridevirtual

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.

Implements mitk::BaseData.

Definition at line 236 of file mitkSurface.cpp.

References GetRequestedRegion(), and mitkThrow.

void mitk::Surface::SetRequestedRegion ( Surface::RegionType * region )

virtual

Definition at line 246 of file mitkSurface.cpp.

References mitkThrow.

void mitk::Surface::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

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

Implements mitk::BaseData.

Definition at line 206 of file mitkSurface.cpp.

void mitk::Surface::SetVtkPolyData	(	vtkPolyData *	polydata,
		unsigned int	t = `0`
	)

virtual

Definition at line 113 of file mitkSurface.cpp.

Referenced by mitk::BoundingObjectGroup::BoundingObjectGroup(), mitk::Cone::Cone(), mitk::LabeledImageToSurfaceFilter::CreateSurface(), mitk::ImageToSurfaceFilter::CreateSurface(), mitk::Cuboid::Cuboid(), mitk::Cylinder::Cylinder(), mitk::Ellipsoid::Ellipsoid(), mitk::ContourModelToSurfaceFilter::GenerateData(), mitk::ExtrudePlanarFigureFilter::GenerateData(), and mitk::Plane::Plane().

void mitk::Surface::Swap ( mitk::Surface & other )

virtual

Definition at line 63 of file mitkSurface.cpp.

References swap().

void mitk::Surface::Update ( )

overridevirtual

Definition at line 266 of file mitkSurface.cpp.

References Update().

void mitk::Surface::UpdateOutputInformation ( )

overridevirtual

Reimplemented in mitk::ExtrudedContour, and mitk::BoundingObjectGroup.

Definition at line 164 of file mitkSurface.cpp.

Referenced by mitk::SurfaceVtkMapper2D::Update().

bool mitk::Surface::VerifyRequestedRegion ( )

overridevirtual

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.

Implements mitk::BaseData.

Reimplemented in mitk::BoundingObjectGroup.

Definition at line 227 of file mitkSurface.cpp.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation