#include <mitkContourModelSet.h>

Inheritance diagram for mitk::ContourModelSet:

[legend]

Collaboration diagram for mitk::ContourModelSet:

[legend]

Public Types
typedef std::deque< mitk::ContourModel::Pointer >	ContourModelListType

typedef ContourModelListType::iterator	ContourModelSetIterator

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 (ContourModelSet, mitk::BaseData)

Pointer	Clone () const

virtual ContourModelSetIterator	Begin ()
	Return an iterator a the front. More...

virtual ContourModelSetIterator	End ()
	Return an iterator a the front. More...

virtual int	GetSize () const
	Returns the number of contained contours. More...

virtual void	AddContourModel (mitk::ContourModel &contourModel)
	Add a ContourModel to the container. More...

virtual void	AddContourModel (mitk::ContourModel::Pointer contourModel)
	Add a ContourModel to the container. More...

virtual mitk::ContourModel *	GetContourModelAt (int index) const
	Returns the ContourModel a given index. More...

ContourModelListType *	GetContourModelList ()
	Returns the container of the contours. More...

bool	IsEmpty () const override
	Returns a bool whether the container is empty or not. More...

virtual bool	RemoveContourModel (mitk::ContourModel *contourModel)
	Remove the given ContourModel from the container if exists. More...

virtual bool	RemoveContourModelAt (int index)
	Remove a ContourModel at given index within the container if exists. More...

void	Clear () override
	Clear the storage container. More...

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

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

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

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

void	UpdateOutputInformation () override
	Update the OutputInformation of a ContourModel object. More...

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

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

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

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

unsigned long	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

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)

	ContourModelSet ()

	ContourModelSet (const mitk::ContourModelSet &other)

	~ContourModelSet () override

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

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

Protected Attributes
ContourModelListType	m_Contours

bool	m_UpdateBoundingBox

Protected Attributes inherited from mitk::BaseData
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Detailed Description

Definition at line 26 of file mitkContourModelSet.h.

Member Typedef Documentation

◆ ContourModelListType

typedef std::deque<mitk::ContourModel::Pointer> mitk::ContourModelSet::ContourModelListType

Definition at line 33 of file mitkContourModelSet.h.

◆ ContourModelSetIterator

typedef ContourModelListType::iterator mitk::ContourModelSet::ContourModelSetIterator

Definition at line 36 of file mitkContourModelSet.h.

Constructor & Destructor Documentation

◆ ContourModelSet() [1/2]

mitk::ContourModelSet::ContourModelSet ( )

protected

Definition at line 16 of file mitkContourModelSet.cpp.

References InitializeEmpty().

◆ ContourModelSet() [2/2]

mitk::ContourModelSet::ContourModelSet ( const mitk::ContourModelSet & other )

protected

Definition at line 21 of file mitkContourModelSet.cpp.

References mitk::BaseData::InitializeTimeGeometry().

◆ ~ContourModelSet()

mitk::ContourModelSet::~ContourModelSet ( )

overrideprotected

Definition at line 27 of file mitkContourModelSet.cpp.

References m_Contours.

Member Function Documentation

◆ AddContourModel() [1/2]

void mitk::ContourModelSet::AddContourModel ( mitk::ContourModel & contourModel )

virtual

Add a ContourModel to the container.

Definition at line 38 of file mitkContourModelSet.cpp.

References m_Contours, and m_UpdateBoundingBox.

◆ AddContourModel() [2/2]

void mitk::ContourModelSet::AddContourModel ( mitk::ContourModel::Pointer contourModel )

virtual

Add a ContourModel to the container.

Definition at line 44 of file mitkContourModelSet.cpp.

References m_Contours, and m_UpdateBoundingBox.

◆ Begin()

virtual ContourModelSetIterator mitk::ContourModelSet::Begin ( )

inlinevirtual

Return an iterator a the front.

Definition at line 42 of file mitkContourModelSet.h.

Referenced by UpdateOutputInformation().

◆ Clear()

void mitk::ContourModelSet::Clear ( )

overridevirtual

Clear the storage container.

Reimplemented from mitk::BaseData.

Definition at line 108 of file mitkContourModelSet.cpp.

References m_Contours, and m_UpdateBoundingBox.

◆ Clone()

Pointer mitk::ContourModelSet::Clone ( ) const

◆ End()

virtual ContourModelSetIterator mitk::ContourModelSet::End ( )

inlinevirtual

Return an iterator a the front.

Definition at line 45 of file mitkContourModelSet.h.

Referenced by UpdateOutputInformation().

◆ GetContourModelAt()

mitk::ContourModel * mitk::ContourModelSet::GetContourModelAt ( int index ) const

virtual

Returns the ContourModel a given index.

Parameters

index

Definition at line 50 of file mitkContourModelSet.cpp.

References m_Contours.

◆ GetContourModelList()

mitk::ContourModelSet::ContourModelListType * mitk::ContourModelSet::GetContourModelList ( )

Returns the container of the contours.

Definition at line 67 of file mitkContourModelSet.cpp.

References m_Contours.

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

◆ GetSize()

virtual int mitk::ContourModelSet::GetSize ( ) const

inlinevirtual

Returns the number of contained contours.

Definition at line 48 of file mitkContourModelSet.h.

◆ InitializeEmpty()

void mitk::ContourModelSet::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 32 of file mitkContourModelSet.cpp.

References mitk::BaseData::InitializeTimeGeometry(), and m_Contours.

Referenced by ContourModelSet().

◆ IsEmpty()

bool mitk::ContourModelSet::IsEmpty ( ) const

overridevirtual

Returns a bool whether the container is empty or not.

Reimplemented from mitk::BaseData.

Definition at line 62 of file mitkContourModelSet.cpp.

References m_Contours.

◆ mitkClassMacro()

mitk::ContourModelSet::mitkClassMacro	(	ContourModelSet	,
		mitk::BaseData
	)

◆ mitkCloneMacro()

mitk::ContourModelSet::mitkCloneMacro ( Self )

protected

◆ New()

static Pointer mitk::ContourModelSet::New ( )

static

Referenced by mitk::ContourModelSetSource::MakeOutput(), mitk::ContourModelSetReader::Read(), mitk::RTStructureSetReaderService::Read(), and mitk::RTStructureSetReaderService::~RTStructureSetReaderService().

◆ RemoveContourModel()

bool mitk::ContourModelSet::RemoveContourModel ( mitk::ContourModel * contourModel )

virtual

Remove the given ContourModel from the container if exists.

Parameters

ContourModel - the ContourModel to be removed.

Definition at line 72 of file mitkContourModelSet.cpp.

References m_Contours, and m_UpdateBoundingBox.

◆ RemoveContourModelAt()

bool mitk::ContourModelSet::RemoveContourModelAt ( int index )

virtual

Remove a ContourModel at given index within the container if exists.

Parameters

index - the index where the ContourModel should be removed.

Definition at line 94 of file mitkContourModelSet.cpp.

References m_Contours, and m_UpdateBoundingBox.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::ContourModelSet::RequestedRegionIsOutsideOfTheBufferedRegion ( )

inlineoverridevirtual

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 91 of file mitkContourModelSet.h.

◆ SetRequestedRegion()

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

inlineoverridevirtual

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 93 of file mitkContourModelSet.h.

References mitkCloneMacro.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::ContourModelSet::SetRequestedRegionToLargestPossibleRegion ( )

inlineoverridevirtual

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 90 of file mitkContourModelSet.h.

◆ UpdateOutputInformation()

void mitk::ContourModelSet::UpdateOutputInformation ( )

override

Update the OutputInformation of a ContourModel object.

The BoundingBox of the contour will be updated, if necessary.

Definition at line 114 of file mitkContourModelSet.cpp.

References Begin(), End(), mitk::BaseData::GetGeometry(), mitk::BaseData::GetMTime(), mitk::BaseData::GetSource(), mitk::BaseData::GetTimeGeometry(), mitk::BaseData::GetTimeSteps(), m_UpdateBoundingBox, mitk::BaseGeometry::SetBounds(), and mitk::TimeGeometry::Update().

◆ VerifyRequestedRegion()

bool mitk::ContourModelSet::VerifyRequestedRegion ( )

inlineoverridevirtual

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.

Definition at line 92 of file mitkContourModelSet.h.

Member Data Documentation

◆ m_Contours

ContourModelListType mitk::ContourModelSet::m_Contours

protected

Definition at line 113 of file mitkContourModelSet.h.

Referenced by AddContourModel(), Clear(), GetContourModelAt(), GetContourModelList(), InitializeEmpty(), IsEmpty(), RemoveContourModel(), RemoveContourModelAt(), and ~ContourModelSet().

◆ m_UpdateBoundingBox

bool mitk::ContourModelSet::m_UpdateBoundingBox

protected

Definition at line 116 of file mitkContourModelSet.h.

Referenced by AddContourModel(), Clear(), RemoveContourModel(), RemoveContourModelAt(), and UpdateOutputInformation().

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

◆ ContourModelListType

◆ ContourModelSetIterator

Constructor & Destructor Documentation

◆ ContourModelSet() [1/2]

◆ ContourModelSet() [2/2]

◆ ~ContourModelSet()

Member Function Documentation

◆ AddContourModel() [1/2]

◆ AddContourModel() [2/2]

◆ Begin()

◆ Clear()

◆ Clone()

◆ End()

◆ GetContourModelAt()

◆ GetContourModelList()

◆ GetSize()

◆ InitializeEmpty()

◆ IsEmpty()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ New()

◆ RemoveContourModel()

◆ RemoveContourModelAt()

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

◆ SetRequestedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

◆ UpdateOutputInformation()

◆ VerifyRequestedRegion()

Member Data Documentation

◆ m_Contours

◆ m_UpdateBoundingBox