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

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

#include <mitkBoundingObjectGroup.h>

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

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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

 mitkClassMacro (BoundingObjectGroup, mitk::BoundingObject)
 
Pointer Clone () const
 
virtual void UpdateOutputInformation () override
 
virtual bool IsInside (const mitk::Point3D &p) const override
 
void SetBoundingObjects (const std::deque< mitk::BoundingObject::Pointer > boundingObjects)
 
std::deque< mitk::BoundingObject::PointerGetBoundingObjects ()
 
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::BaseGeometryGetGeometry (int t=0) const
 
virtual 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 ()
 
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 RegionTypeGetLargestPossibleRegion () const
 
virtual const RegionTypeGetRequestedRegion () 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
 
- Public Member Functions inherited from mitk::BaseData
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (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::BaseDataSourceGetSource () 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 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 ()
 
virtual ~BoundingObjectGroup ()
 
- Protected Member Functions inherited from mitk::BoundingObject
 BoundingObject ()
 
virtual ~BoundingObject ()
 
bool WriteXMLData (XMLWriter &xmlWriter)
 
- Protected Member Functions inherited from mitk::Surface
virtual itk::LightObject::Pointer InternalClone () const override
 
 Surface ()
 
virtual ~Surface ()
 
 Surface (const Surface &other)
 
Surfaceoperator= (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...
 

Protected Attributes

std::deque< mitk::BoundingObject::Pointerm_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 30 of file mitkBoundingObjectGroup.h.

Constructor & Destructor Documentation

mitk::BoundingObjectGroup::BoundingObjectGroup ( )
protected
mitk::BoundingObjectGroup::~BoundingObjectGroup ( )
protectedvirtual

Definition at line 32 of file mitkBoundingObjectGroup.cpp.

Member Function Documentation

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

Definition at line 101 of file mitkBoundingObjectGroup.cpp.

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

Definition at line 203 of file mitkBoundingObjectGroup.cpp.

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

Definition at line 170 of file mitkBoundingObjectGroup.cpp.

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

Definition at line 180 of file mitkBoundingObjectGroup.cpp.

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

Implements mitk::BoundingObject.

Definition at line 124 of file mitkBoundingObjectGroup.cpp.

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

Definition at line 111 of file mitkBoundingObjectGroup.cpp.

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

Definition at line 198 of file mitkBoundingObjectGroup.cpp.

virtual void mitk::BoundingObjectGroup::SetCSGMode ( mitk::BoundingObjectGroup::CSGMode  _arg)
virtual
void mitk::BoundingObjectGroup::UpdateOutputInformation ( )
overridevirtual
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 175 of file mitkBoundingObjectGroup.cpp.

Member Data Documentation

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

Definition at line 64 of file mitkBoundingObjectGroup.h.

unsigned int mitk::BoundingObjectGroup::m_Counter
protected

Definition at line 65 of file mitkBoundingObjectGroup.h.

CSGMode mitk::BoundingObjectGroup::m_CSGMode
protected

Definition at line 66 of file mitkBoundingObjectGroup.h.


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