Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::UnstructuredGrid Class Reference

Class for storing unstructured grids (vtkUnstructuredGrid) More...

#include <mitkUnstructuredGrid.h>

Inheritance diagram for mitk::UnstructuredGrid:
Collaboration diagram for mitk::UnstructuredGrid:

Public Types

typedef itk::ImageRegion< 5 > RegionType
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Identifiable
using UIDType = std::string
 

Public Member Functions

 mitkClassMacro (UnstructuredGrid, BaseData)
 
Pointer Clone () const
 
virtual void SetVtkUnstructuredGrid (vtkUnstructuredGrid *grid, unsigned int t=0)
 
virtual vtkUnstructuredGrid * GetVtkUnstructuredGrid (unsigned int t=0)
 
void UpdateOutputInformation () override
 
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 *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 (UnstructuredGrid::RegionType *region)
 
void Graft (const DataObject *data) override
 
void CopyInformation (const itk::DataObject *data) override
 
void Update () override
 
void Expand (unsigned int timeSteps=1) override
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const RegionTypeGetLargestPossibleRegion () const
 
virtual const RegionTypeGetRequestedRegion () const
 
void CalculateBoundingBox ()
 
- 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...
 
BasePropertyGetNonConstProperty (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::TimeGeometryGetTimeGeometry () 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::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 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::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...
 
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 ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (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 Types

typedef std::vector< vtkUnstructuredGrid * > VTKUnstructuredGridSeries
 

Protected Member Functions

 mitkCloneMacro (Self)
 
 UnstructuredGrid ()
 
 UnstructuredGrid (const mitk::UnstructuredGrid &other)
 
 ~UnstructuredGrid () override
 
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

VTKUnstructuredGridSeries m_GridSeries
 
RegionType m_LargestPossibleRegion
 
RegionType m_RequestedRegion
 
bool m_CalculateBoundingBox
 
- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

Class for storing unstructured grids (vtkUnstructuredGrid)

Definition at line 27 of file mitkUnstructuredGrid.h.

Member Typedef Documentation

◆ RegionType

typedef itk::ImageRegion<5> mitk::UnstructuredGrid::RegionType

Definition at line 31 of file mitkUnstructuredGrid.h.

◆ VTKUnstructuredGridSeries

typedef std::vector<vtkUnstructuredGrid *> mitk::UnstructuredGrid::VTKUnstructuredGridSeries
protected

Definition at line 82 of file mitkUnstructuredGrid.h.

Constructor & Destructor Documentation

◆ UnstructuredGrid() [1/2]

mitk::UnstructuredGrid::UnstructuredGrid ( )
protected

◆ UnstructuredGrid() [2/2]

mitk::UnstructuredGrid::UnstructuredGrid ( const mitk::UnstructuredGrid other)
protected

◆ ~UnstructuredGrid()

mitk::UnstructuredGrid::~UnstructuredGrid ( )
overrideprotected

Member Function Documentation

◆ CalculateBoundingBox()

void mitk::UnstructuredGrid::CalculateBoundingBox ( )

◆ ClearData()

void mitk::UnstructuredGrid::ClearData ( )
overrideprotectedvirtual

reset to non-initialized state, release memory

Reimplemented from mitk::BaseData.

◆ Clone()

Pointer mitk::UnstructuredGrid::Clone ( ) const

◆ CopyInformation()

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

◆ Expand()

void mitk::UnstructuredGrid::Expand ( unsigned int  timeSteps = 1)
overridevirtual

Expands the TimeGeometry to a number of TimeSteps.

The method expands the TimeGeometry to the given number of TimeSteps, filling newly created elements with empty geometries. Sub-classes should override this method to handle the elongation of their data vectors, too. Note that a shrinking is neither possible nor intended.

Reimplemented from mitk::BaseData.

◆ GetLargestPossibleRegion()

const RegionType& mitk::UnstructuredGrid::GetLargestPossibleRegion ( ) const
inline

Definition at line 65 of file mitkUnstructuredGrid.h.

◆ GetRequestedRegion()

virtual const RegionType& mitk::UnstructuredGrid::GetRequestedRegion ( ) const
inlinevirtual

Get the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter).

Definition at line 76 of file mitkUnstructuredGrid.h.

◆ GetVtkUnstructuredGrid()

virtual vtkUnstructuredGrid* mitk::UnstructuredGrid::GetVtkUnstructuredGrid ( unsigned int  t = 0)
virtual

◆ Graft()

void mitk::UnstructuredGrid::Graft ( const DataObject *  data)
override

◆ InitializeEmpty()

void mitk::UnstructuredGrid::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.

◆ mitkClassMacro()

mitk::UnstructuredGrid::mitkClassMacro ( UnstructuredGrid  ,
BaseData   
)

◆ mitkCloneMacro()

mitk::UnstructuredGrid::mitkCloneMacro ( Self  )
protected

◆ New()

static Pointer mitk::UnstructuredGrid::New ( )
static

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::UnstructuredGrid::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

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.

◆ SetRequestedRegion() [1/2]

void mitk::UnstructuredGrid::SetRequestedRegion ( const itk::DataObject *  data)
overridevirtual

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.

◆ SetRequestedRegion() [2/2]

virtual void mitk::UnstructuredGrid::SetRequestedRegion ( UnstructuredGrid::RegionType region)
virtual

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::UnstructuredGrid::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

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.

◆ SetVtkUnstructuredGrid()

virtual void mitk::UnstructuredGrid::SetVtkUnstructuredGrid ( vtkUnstructuredGrid *  grid,
unsigned int  t = 0 
)
virtual

◆ Update()

void mitk::UnstructuredGrid::Update ( )
override

◆ UpdateOutputInformation()

void mitk::UnstructuredGrid::UpdateOutputInformation ( )
override

◆ VerifyRequestedRegion()

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

Implements mitk::BaseData.

Member Data Documentation

◆ m_CalculateBoundingBox

bool mitk::UnstructuredGrid::m_CalculateBoundingBox
protected

Definition at line 100 of file mitkUnstructuredGrid.h.

◆ m_GridSeries

VTKUnstructuredGridSeries mitk::UnstructuredGrid::m_GridSeries
protected

Definition at line 94 of file mitkUnstructuredGrid.h.

◆ m_LargestPossibleRegion

RegionType mitk::UnstructuredGrid::m_LargestPossibleRegion
mutableprotected

Definition at line 96 of file mitkUnstructuredGrid.h.

◆ m_RequestedRegion

RegionType mitk::UnstructuredGrid::m_RequestedRegion
protected

Definition at line 98 of file mitkUnstructuredGrid.h.


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