Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::BoundingObjectGroup Class Reference

Group object that contains several mitk::BoundingObject instances. More...

#include <mitkBoundingObjectGroup.h>

Inheritance diagram for mitk::BoundingObjectGroup:
Collaboration diagram for mitk::BoundingObjectGroup:

Public Types

enum  CSGMode { Union , Intersection , Difference }
 CSG combination mode for the group. More...
 
- Public Types inherited from mitk::Surface
typedef itk::ImageRegion< 5 > RegionType
 Region type used for pipeline region negotiation (5-dimensional). More...
 
- Public Types inherited from mitk::Identifiable
using UIDType = std::string
 Type alias for unique identifiers. More...
 

Public Member Functions

 mitkClassMacro (BoundingObjectGroup, mitk::BoundingObject)
 
Pointer Clone () const
 
void UpdateOutputInformation () override
 Recompute the combined bounding box from all sub-objects. More...
 
bool IsInside (const mitk::Point3D &p) const override
 Test whether a point is inside the group according to the current CSGMode. More...
 
void SetBoundingObjects (const std::deque< mitk::BoundingObject::Pointer > boundingObjects)
 Replace the internal collection of bounding objects. More...
 
std::deque< mitk::BoundingObject::Pointer > GetBoundingObjects ()
 Get a copy of the internal bounding object collection. More...
 
virtual void SetCSGMode (mitk::BoundingObjectGroup::CSGMode _arg)
 Set the CSG combination mode (Union, Intersection, or Difference). More...
 
virtual mitk::BoundingObjectGroup::CSGMode GetCSGMode ()
 Get the current CSG combination mode. More...
 
void AddBoundingObject (mitk::BoundingObject::Pointer boundingObject)
 Add a bounding object to the group. More...
 
void RemoveBoundingObject (mitk::BoundingObject::Pointer boundingObject)
 Remove a bounding object from the group. More...
 
unsigned int GetCount () const
 Get the number of bounding objects in this group. More...
 
mitk::BaseGeometry * GetGeometry (int t=0) const
 Get the geometry for the given time step. More...
 
bool VerifyRequestedRegion () override
 Verify that the requested region is valid. More...
 
- Public Member Functions inherited from mitk::BoundingObject
 mitkClassMacro (BoundingObject, mitk::Surface)
 
virtual mitk::ScalarType GetVolume ()
 Calculate and return the volume of this bounding object. More...
 
virtual bool GetPositive ()
 Get whether this bounding object defines a positive volume. More...
 
virtual void SetPositive (bool _arg)
 Set whether this bounding object defines a positive volume. More...
 
virtual void PositiveOn ()
 Toggle the Positive flag. More...
 
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
 mitkClassMacro (Surface, BaseData)
 
Pointer Clone () const
 
void CalculateBoundingBox ()
 Compute the bounding box from all vtkPolyData objects across time steps. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information (geometry, region) from another data object. More...
 
void ExecuteOperation (Operation *operation) override
 Execute an operation on this surface (e.g., OpSURFACECHANGED). More...
 
void Expand (unsigned int timeSteps=1) override
 Expand the data to the given number of time steps. More...
 
const RegionType & GetLargestPossibleRegion () const
 Get the largest possible region. More...
 
virtual const RegionType & GetRequestedRegion () const
 Get the requested region. More...
 
unsigned int GetSizeOfPolyDataSeries () const
 Get the number of vtkPolyData objects in the time series. More...
 
virtual vtkPolyData * GetVtkPolyData (unsigned int t=0) const
 Get the vtkPolyData at time step t. More...
 
void Graft (const DataObject *data) override
 Graft data and information from another data object. More...
 
bool IsEmptyTimeStep (unsigned int t) const override
 Check whether time step t is empty (has no vtkPolyData). More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 Print the surface information to the output stream. More...
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 Determine whether the requested region is outside the buffered region. More...
 
void SetRequestedRegion (const itk::DataObject *data) override
 Set the requested region to match another data object's requested region. More...
 
virtual void SetRequestedRegion (Surface::RegionType *region)
 Set the requested region from a RegionType pointer. More...
 
void SetRequestedRegionToLargestPossibleRegion () override
 Set the requested region to the largest possible region. More...
 
virtual void SetVtkPolyData (vtkPolyData *polydata, unsigned int t=0)
 Set the vtkPolyData for time step t. More...
 
virtual void Swap (Surface &other)
 Swap the contents of this surface with another surface. More...
 
void Update () override
 Trigger an update of all vtkPolyData objects in the pipeline. More...
 
void UpdateOutputInformation () override
 Update the output information (bounding box, geometry). More...
 
- Public Member Functions inherited from mitk::BaseData
 mitkClassMacroItkParent (BaseData, itk::DataObject)
 
BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
 Get a const property by its key. More...
 
std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
 Get all property keys stored in the property list. More...
 
std::vector< std::string > GetPropertyContextNames () const override
 Get the names of all property contexts. More...
 
BaseProperty * GetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
 Get a non-const property by its key. More...
 
void SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Set a property in the property list. More...
 
void RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Remove a property from the property list. 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 non-const pointer. More...
 
const mitk::TimeGeometry * GetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data after ensuring it is up-to-date. More...
 
const mitk::BaseGeometry * GetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time step t after ensuring it is up-to-date. More...
 
mitk::BaseGeometry * GetGeometry (int t=0) const
 Return the BaseGeometry of the data at time step t as a non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData 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. More...
 
virtual void Clear ()
 Reset the data object by calling ClearData() and InitializeEmpty(). More...
 
virtual bool IsEmpty () const
 Check whether the object contains data at any time step. More...
 
virtual void SetGeometry (BaseGeometry *aGeometry3D)
 Set the BaseGeometry of the data, which will be referenced (not copied!). 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 the BaseGeometry of the data. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as the TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as the 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, replacing the existing one. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get a property by its key from the PropertyList. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 Set a property in the PropertyList. More...
 
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. More...
 
itk::ModifiedTimeType GetMTime () const override
 Get the modification time of this data object or its geometry, whichever was modified most recently. More...
 
void Graft (const DataObject *) override
 Graft data and information from another data object. More...
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 
- Public Member Functions inherited from mitk::Identifiable
 Identifiable ()
 Default constructor. Generates a new random UID. More...
 
 Identifiable (const UIDType &uid)
 Construct with a pre-existing UID. More...
 
 Identifiable (const Identifiable &)=delete
 Copy construction is deleted to prevent UID duplication. More...
 
 Identifiable (Identifiable &&) noexcept
 Move constructor. Transfers ownership of the UID. More...
 
virtual ~Identifiable ()
 Virtual destructor. More...
 
Identifiable & operator= (const Identifiable &)=delete
 Copy assignment is deleted to prevent UID duplication. More...
 
Identifiable & operator= (Identifiable &&other) noexcept
 Move assignment operator. Transfers ownership of the UID. More...
 
virtual UIDType GetUID () const
 Get the unique identifier of this object. More...
 
UIDType GetRuntimeUID () const noexcept
 Get a runtime-unique ID for this object instance. More...
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
virtual bool PropertyIsOwned (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const
 Checks if a certain property exists. More...
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 Virtual destructor. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::Surface
static Pointer New ()
 

Protected Member Functions

 BoundingObjectGroup ()
 
 ~BoundingObjectGroup () override
 
- Protected Member Functions inherited from mitk::BoundingObject
 BoundingObject ()
 
 ~BoundingObject () override
 
- Protected Member Functions inherited from mitk::Surface
 mitkCloneMacro (Self)
 
 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...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::Identifiable
virtual void SetUID (const UIDType &uid)
 

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::BoundingObject instances.

Calculates a combined bounding box that encloses all sub-bounding objects. Supports Constructive Solid Geometry (CSG) operations: Union, Intersection, and Difference, which control how IsInside() evaluates membership.

Positive bounding objects are pushed to the front of the internal deque, negative ones to the back.

See also
BoundingObject, Cone, Cuboid, Cylinder, Ellipsoid

Definition at line 35 of file mitkBoundingObjectGroup.h.

Member Enumeration Documentation

◆ CSGMode

CSG combination mode for the group.

Enumerator
Union 

A point is inside if it is inside at least one positive and no negative object.

Intersection 

A point is inside only if it is inside every object.

Difference 

Same logic as Union (positive minus negative volumes).

Definition at line 41 of file mitkBoundingObjectGroup.h.

Constructor & Destructor Documentation

◆ BoundingObjectGroup()

mitk::BoundingObjectGroup::BoundingObjectGroup ( )
protected

◆ ~BoundingObjectGroup()

mitk::BoundingObjectGroup::~BoundingObjectGroup ( )
overrideprotected

Member Function Documentation

◆ AddBoundingObject()

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

Add a bounding object to the group.

Positive objects are inserted at the front, negative objects at the back. Triggers an update of the combined bounding box.

Parameters
[in]boundingObjectThe bounding object to add.

◆ Clone()

Pointer mitk::BoundingObjectGroup::Clone ( ) const

◆ GetBoundingObjects()

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

Get a copy of the internal bounding object collection.

Returns
A deque of BoundingObject smart pointers.

◆ GetCount()

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

Get the number of bounding objects in this group.

Returns
The current count.

◆ GetCSGMode()

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

Get the current CSG combination mode.

◆ GetGeometry()

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

Get the geometry for the given time step.

Parameters
[in]tThe time step (default is 0).
Returns
The geometry at the given time step.

◆ IsInside()

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

Test whether a point is inside the group according to the current CSGMode.

Parameters
[in]pThe point in world coordinates.
Returns
true if the point satisfies the CSG condition.

Implements mitk::BoundingObject.

◆ mitkClassMacro()

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

◆ New()

static Pointer mitk::BoundingObjectGroup::New ( )
static

◆ RemoveBoundingObject()

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

Remove a bounding object from the group.

Triggers an update of the combined bounding box.

Parameters
[in]boundingObjectThe bounding object to remove.

◆ SetBoundingObjects()

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

Replace the internal collection of bounding objects.

Parameters
[in]boundingObjectsThe new deque of bounding objects.

◆ SetCSGMode()

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

Set the CSG combination mode (Union, Intersection, or Difference).

◆ UpdateOutputInformation()

void mitk::BoundingObjectGroup::UpdateOutputInformation ( )
override

Recompute the combined bounding box from all sub-objects.

◆ VerifyRequestedRegion()

bool mitk::BoundingObjectGroup::VerifyRequestedRegion ( )
overridevirtual

Verify that the requested region is valid.

Returns
true if the group contains at least one bounding object.

Reimplemented from mitk::Surface.

Member Data Documentation

◆ m_BoundingObjects

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

Definition at line 127 of file mitkBoundingObjectGroup.h.

◆ m_Counter

unsigned int mitk::BoundingObjectGroup::m_Counter
protected

Definition at line 128 of file mitkBoundingObjectGroup.h.

◆ m_CSGMode

CSGMode mitk::BoundingObjectGroup::m_CSGMode
protected

Definition at line 129 of file mitkBoundingObjectGroup.h.


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