Stores vertices for drawing a contour. More...

#include <mitkContour.h>

Inheritance diagram for mitk::Contour:

[legend]

Collaboration diagram for mitk::Contour:

[legend]

Public Types
typedef itk::PolyLineParametricPath< 3 >	PathType

typedef PathType::Pointer	PathPointer

typedef PathType::ContinuousIndexType	ContinuousIndexType

typedef PathType::InputType	InputType

typedef PathType::OutputType	OutputType

typedef PathType::OffsetType	OffsetType

typedef itk::BoundingBox< unsigned long, 3, ScalarType, itk::VectorContainer< unsigned long, mitk::Point< ScalarType, 3 > > >	BoundingBoxType

typedef BoundingBoxType::PointsContainer	PointsContainer

typedef BoundingBoxType::PointsContainer::Pointer	PointsContainerPointer

typedef BoundingBoxType::PointsContainerIterator	PointsContainerIterator

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 Types inherited from mitk::Identifiable
using	UIDType = std::string

Public Member Functions
	mitkClassMacro (Contour, BaseData)

Pointer	Clone () const

virtual void	SetClosed (bool _arg)

virtual bool	GetClosed ()

virtual void	SetSelected (bool _arg)

virtual bool	GetSelected ()

virtual void	SetWidth (float _arg)

virtual float	GetWidth ()

void	Initialize () override

void	AddVertex (mitk::Point3D newPoint)

PathPointer	GetContourPath () const

void	SetCurrentWindow (vtkRenderWindow *rw)

vtkRenderWindow *	GetCurrentWindow () const

unsigned int	GetNumberOfPoints () const

PointsContainerPointer	GetPoints () const

void	SetPoints (PointsContainerPointer points)

void	UpdateOutputInformation () override

void	SetRequestedRegionToLargestPossibleRegion () override

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

bool	VerifyRequestedRegion () override

void	SetRequestedRegion (const itk::DataObject *data) override

Public Member Functions inherited from mitk::BaseData
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	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	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 Pointer	New ()

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

Protected Member Functions
	mitkCloneMacro (Self)

	Contour ()

	Contour (const Contour &other)

	~Contour () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const 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
Protected Attributes inherited from mitk::BaseData
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Detailed Description

Stores vertices for drawing a contour.

Deprecated:: Use class mitk::ContourModel instead.

See also: ContourModel

Definition at line 31 of file mitkContour.h.

Member Typedef Documentation

◆ BoundingBoxType

typedef itk:: BoundingBox<unsigned long, 3, ScalarType, itk::VectorContainer<unsigned long, mitk::Point<ScalarType, 3> > > mitk::Contour::BoundingBoxType

Definition at line 48 of file mitkContour.h.

◆ ContinuousIndexType

typedef PathType::ContinuousIndexType mitk::Contour::ContinuousIndexType

Definition at line 42 of file mitkContour.h.

◆ InputType

typedef PathType::InputType mitk::Contour::InputType

Definition at line 43 of file mitkContour.h.

◆ OffsetType

typedef PathType::OffsetType mitk::Contour::OffsetType

Definition at line 45 of file mitkContour.h.

◆ OutputType

typedef PathType::OutputType mitk::Contour::OutputType

Definition at line 44 of file mitkContour.h.

◆ PathPointer

typedef PathType::Pointer mitk::Contour::PathPointer

Definition at line 41 of file mitkContour.h.

◆ PathType

typedef itk::PolyLineParametricPath<3> mitk::Contour::PathType

Definition at line 38 of file mitkContour.h.

◆ PointsContainer

typedef BoundingBoxType::PointsContainer mitk::Contour::PointsContainer

Definition at line 49 of file mitkContour.h.

◆ PointsContainerIterator

typedef BoundingBoxType::PointsContainerIterator mitk::Contour::PointsContainerIterator

Definition at line 51 of file mitkContour.h.

◆ PointsContainerPointer

typedef BoundingBoxType::PointsContainer::Pointer mitk::Contour::PointsContainerPointer

Definition at line 50 of file mitkContour.h.

Constructor & Destructor Documentation

◆ Contour() [1/2]

mitk::Contour::Contour ( )

protected

◆ Contour() [2/2]

mitk::Contour::Contour ( const Contour & other )

protected

◆ ~Contour()

mitk::Contour::~Contour ( )

overrideprotected

Member Function Documentation

◆ AddVertex()

void mitk::Contour::AddVertex ( mitk::Point3D newPoint )

add a new vertex to the contour

◆ Clone()

Pointer mitk::Contour::Clone ( ) const

◆ GetClosed()

virtual bool mitk::Contour::GetClosed ( )

virtual

returns if the contour is closed or opened

◆ GetContourPath()

PathPointer mitk::Contour::GetContourPath ( ) const

return an itk parametric path of the contour

◆ GetCurrentWindow()

vtkRenderWindow* mitk::Contour::GetCurrentWindow ( ) const

returns the points to the current render window

◆ GetNumberOfPoints()

unsigned int mitk::Contour::GetNumberOfPoints ( ) const

returns the number of points stored in the contour

◆ GetPoints()

PointsContainerPointer mitk::Contour::GetPoints ( ) const

returns the container of the contour points

◆ GetSelected()

virtual bool mitk::Contour::GetSelected ( )

virtual

◆ GetWidth()

virtual float mitk::Contour::GetWidth ( )

virtual

◆ Initialize()

void mitk::Contour::Initialize ( )

override

clean up the contour data

◆ mitkClassMacro()

mitk::Contour::mitkClassMacro	(	Contour	,
		BaseData
	)

◆ mitkCloneMacro()

mitk::Contour::mitkCloneMacro ( Self )

protected

◆ New()

static Pointer mitk::Contour::New ( )

static

◆ PrintSelf()

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

overrideprotected

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::Contour::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

intherited from parent

Implements mitk::BaseData.

◆ SetClosed()

virtual void mitk::Contour::SetClosed ( bool _arg )

virtual

sets whether the contour should be closed or open. by default the contour is closed

◆ SetCurrentWindow()

void mitk::Contour::SetCurrentWindow ( vtkRenderWindow * rw )

set the current render window. This is helpful if one wants to draw the contour in one special window only.

◆ SetPoints()

void mitk::Contour::SetPoints ( PointsContainerPointer points )

set the contour points container.

◆ SetRequestedRegion()

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

overridevirtual

intherited from parent

Implements mitk::BaseData.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::Contour::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

intherited from parent

Implements mitk::BaseData.

◆ SetSelected()

virtual void mitk::Contour::SetSelected ( bool _arg )

virtual

◆ SetWidth()

virtual void mitk::Contour::SetWidth ( float _arg )

virtual

◆ UpdateOutputInformation()

void mitk::Contour::UpdateOutputInformation ( )

override

intherited from parent

◆ VerifyRequestedRegion()

bool mitk::Contour::VerifyRequestedRegion ( )

overridevirtual

intherited from parent

Implements mitk::BaseData.

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

mitkContour.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BoundingBoxType

◆ ContinuousIndexType

◆ InputType

◆ OffsetType

◆ OutputType

◆ PathPointer

◆ PathType

◆ PointsContainer

◆ PointsContainerIterator

◆ PointsContainerPointer

Constructor & Destructor Documentation

◆ Contour() [1/2]

◆ Contour() [2/2]

◆ ~Contour()

Member Function Documentation

◆ AddVertex()

◆ Clone()

◆ GetClosed()

◆ GetContourPath()

◆ GetCurrentWindow()

◆ GetNumberOfPoints()

◆ GetPoints()

◆ GetSelected()

◆ GetWidth()

◆ Initialize()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ New()

◆ PrintSelf()

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

◆ SetClosed()

◆ SetCurrentWindow()

◆ SetPoints()

◆ SetRequestedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

◆ SetSelected()

◆ SetWidth()

◆ UpdateOutputInformation()

◆ VerifyRequestedRegion()