group object, that contains several mitk::BoundingObjects More...

#include <mitkBoundingObjectGroup.h>

Inheritance diagram for mitk::BoundingObjectGroup:

[legend]

Collaboration diagram for mitk::BoundingObjectGroup:

[legend]

Public Types
enum	CSGMode { Union, Intersection, Difference }

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

Public Member Functions
	mitkClassMacro (BoundingObjectGroup, mitk::BoundingObject)

Pointer	Clone () const

void	UpdateOutputInformation () override

bool	IsInside (const mitk::Point3D &p) const override

void	SetBoundingObjects (const std::deque< mitk::BoundingObject::Pointer > boundingObjects)

std::deque< mitk::BoundingObject::Pointer >	GetBoundingObjects ()

virtual void	SetCSGMode (mitk::BoundingObjectGroup::CSGMode _arg)

virtual mitk::BoundingObjectGroup::CSGMode	GetCSGMode ()

void	AddBoundingObject (mitk::BoundingObject::Pointer boundingObject)

void	RemoveBoundingObject (mitk::BoundingObject::Pointer boundingObject)

unsigned int	GetCount () const

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

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

Public Member Functions inherited from mitk::BoundingObject
	mitkClassMacro (BoundingObject, mitk::Surface)

virtual mitk::ScalarType	GetVolume ()

virtual bool	GetPositive ()

virtual void	SetPositive (bool _arg)

virtual void	PositiveOn ()

virtual void	PositiveOff ()

virtual void	FitGeometry (BaseGeometry *aGeometry3D)
	Sets the Geometry3D of the bounding object to fit the given geometry. More...

Public Member Functions inherited from mitk::Surface
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

Pointer	Clone () const

void	CalculateBoundingBox ()

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

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

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

void	Graft (const DataObject *data) override

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

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

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

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)

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

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

virtual void	Swap (Surface &other)

void	Update () override

void	UpdateOutputInformation () override

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

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 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::Surface
static const char *	GetStaticNameOfClass ()

static Pointer	New ()

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

Protected Member Functions
	BoundingObjectGroup ()

	~BoundingObjectGroup () override

Protected Member Functions inherited from mitk::BoundingObject
	BoundingObject ()

	~BoundingObject () override

bool	WriteXMLData (XMLWriter &xmlWriter)

Protected Member Functions inherited from mitk::Surface
virtual itk::LightObject::Pointer	InternalClone () const override

	Surface ()

	~Surface () override

	Surface (const Surface &other)

Surface &	operator= (Surface other)

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

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

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

Protected Attributes
std::deque< mitk::BoundingObject::Pointer >	m_BoundingObjects

unsigned int	m_Counter

CSGMode	m_CSGMode

Protected Attributes inherited from mitk::BoundingObject
bool	m_Positive
	If true, the Boundingobject describes a positive volume, if false a negative volume. More...

Protected Attributes inherited from mitk::BaseData
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Detailed Description

group object, that contains several mitk::BoundingObjects

Calculates a bounding box that contains all sub-bounding boxes.

Definition at line 26 of file mitkBoundingObjectGroup.h.

Member Enumeration Documentation

◆ CSGMode

enum mitk::BoundingObjectGroup::CSGMode

Enumerator
Union
Intersection
Difference

Definition at line 29 of file mitkBoundingObjectGroup.h.

Constructor & Destructor Documentation

◆ BoundingObjectGroup()

mitk::BoundingObjectGroup::BoundingObjectGroup ( )

protected

Definition at line 18 of file mitkBoundingObjectGroup.cpp.

References mitk::ProportionalTimeGeometry::New(), mitk::BaseData::SetTimeGeometry(), and mitk::Surface::SetVtkPolyData().

◆ ~BoundingObjectGroup()

mitk::BoundingObjectGroup::~BoundingObjectGroup ( )

overrideprotected

Definition at line 28 of file mitkBoundingObjectGroup.cpp.

Member Function Documentation

◆ AddBoundingObject()

void mitk::BoundingObjectGroup::AddBoundingObject ( mitk::BoundingObject::Pointer boundingObject )

Definition at line 97 of file mitkBoundingObjectGroup.cpp.

References m_BoundingObjects, m_Counter, and UpdateOutputInformation().

◆ Clone()

Pointer mitk::BoundingObjectGroup::Clone ( ) const

◆ GetBoundingObjects()

std::deque< mitk::BoundingObject::Pointer > mitk::BoundingObjectGroup::GetBoundingObjects ( )

Definition at line 199 of file mitkBoundingObjectGroup.cpp.

References m_BoundingObjects.

◆ GetCount()

unsigned int mitk::BoundingObjectGroup::GetCount ( ) const

Definition at line 166 of file mitkBoundingObjectGroup.cpp.

References m_Counter.

◆ GetCSGMode()

virtual mitk::BoundingObjectGroup::CSGMode mitk::BoundingObjectGroup::GetCSGMode ( )

virtual

◆ GetGeometry()

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

Definition at line 176 of file mitkBoundingObjectGroup.cpp.

Referenced by UpdateOutputInformation().

◆ IsInside()

bool mitk::BoundingObjectGroup::IsInside ( const mitk::Point3D & p ) const

overridevirtual

Implements mitk::BoundingObject.

Definition at line 120 of file mitkBoundingObjectGroup.cpp.

References Difference, Intersection, m_BoundingObjects, m_CSGMode, and Union.

◆ mitkClassMacro()

mitk::BoundingObjectGroup::mitkClassMacro	(	BoundingObjectGroup	,
		mitk::BoundingObject
	)

◆ New()

static Pointer mitk::BoundingObjectGroup::New ( )

static

Referenced by QmitkBoundingObjectWidget::GetAllBoundingObjects(), and mitk::BoundingObjectToSegmentationFilter::SetBoundingObject().

◆ RemoveBoundingObject()

void mitk::BoundingObjectGroup::RemoveBoundingObject ( mitk::BoundingObject::Pointer boundingObject )

Definition at line 107 of file mitkBoundingObjectGroup.cpp.

References m_BoundingObjects, m_Counter, and UpdateOutputInformation().

◆ SetBoundingObjects()

void mitk::BoundingObjectGroup::SetBoundingObjects ( const std::deque< mitk::BoundingObject::Pointer > boundingObjects )

Definition at line 194 of file mitkBoundingObjectGroup.cpp.

References m_BoundingObjects.

◆ SetCSGMode()

virtual void mitk::BoundingObjectGroup::SetCSGMode ( mitk::BoundingObjectGroup::CSGMode _arg )

virtual

◆ UpdateOutputInformation()

void mitk::BoundingObjectGroup::UpdateOutputInformation ( )

override

Definition at line 32 of file mitkBoundingObjectGroup.cpp.

References mitk::TimeGeometry::GetCornerPointInWorld(), GetGeometry(), mitk::BaseGeometry::GetIndexToWorldTransform(), mitk::BaseData::GetSource(), mitk::BaseData::GetTimeGeometry(), mitk::large, m_BoundingObjects, mitk::ProportionalTimeGeometry::New(), mitk::BaseGeometry::SetBounds(), mitk::BaseGeometry::SetIndexToWorldTransform(), mitk::BaseData::SetTimeGeometry(), and mitk::TimeGeometry::Update().

Referenced by AddBoundingObject(), and RemoveBoundingObject().

◆ VerifyRequestedRegion()

bool mitk::BoundingObjectGroup::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.

Reimplemented from mitk::Surface.

Definition at line 171 of file mitkBoundingObjectGroup.cpp.

References m_Counter.

Member Data Documentation

◆ m_BoundingObjects

std::deque<mitk::BoundingObject::Pointer> mitk::BoundingObjectGroup::m_BoundingObjects

protected

Definition at line 61 of file mitkBoundingObjectGroup.h.

Referenced by AddBoundingObject(), GetBoundingObjects(), IsInside(), RemoveBoundingObject(), SetBoundingObjects(), and UpdateOutputInformation().

◆ m_Counter

unsigned int mitk::BoundingObjectGroup::m_Counter

protected

Definition at line 62 of file mitkBoundingObjectGroup.h.

Referenced by AddBoundingObject(), GetCount(), RemoveBoundingObject(), and VerifyRequestedRegion().

◆ m_CSGMode

CSGMode mitk::BoundingObjectGroup::m_CSGMode

protected

Definition at line 63 of file mitkBoundingObjectGroup.h.

Referenced by IsInside().

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 Enumeration Documentation

◆ CSGMode

Constructor & Destructor Documentation

◆ BoundingObjectGroup()

◆ ~BoundingObjectGroup()

Member Function Documentation

◆ AddBoundingObject()

◆ Clone()

◆ GetBoundingObjects()

◆ GetCount()

◆ GetCSGMode()

◆ GetGeometry()

◆ IsInside()

◆ mitkClassMacro()

◆ New()

◆ RemoveBoundingObject()

◆ SetBoundingObjects()

◆ SetCSGMode()

◆ UpdateOutputInformation()

◆ VerifyRequestedRegion()

Member Data Documentation

◆ m_BoundingObjects

◆ m_Counter

◆ m_CSGMode