Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::Surface Class Reference

Class for storing surfaces (vtkPolyData). More...

#include <mitkSurface.h>

Inheritance diagram for mitk::Surface:
Collaboration diagram for mitk::Surface:

Public Types

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

Public Member Functions

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 RegionTypeGetLargestPossibleRegion () const
 
virtual const RegionTypeGetRequestedRegion () 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
 
bool VerifyRequestedRegion () override
 Verify that the RequestedRegion is within the LargestPossibleRegion. More...
 
- 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...
 
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...
 
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 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...
 
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 ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (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 const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

virtual itk::LightObject::Pointer InternalClone () const override
 
 Surface ()
 
 ~Surface () override
 
 Surface (const Surface &other)
 
Surfaceoperator= (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
 

Additional Inherited Members

- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

Class for storing surfaces (vtkPolyData).

Definition at line 28 of file mitkSurface.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 33 of file mitkSurface.h.

◆ Pointer

Definition at line 33 of file mitkSurface.h.

◆ RegionType

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

Definition at line 31 of file mitkSurface.h.

◆ Self

Definition at line 33 of file mitkSurface.h.

◆ Superclass

Definition at line 33 of file mitkSurface.h.

Constructor & Destructor Documentation

◆ Surface() [1/2]

mitk::Surface::Surface ( )
protected

Definition at line 37 of file mitkSurface.cpp.

References InitializeEmpty().

◆ ~Surface()

mitk::Surface::~Surface ( )
overrideprotected

Definition at line 73 of file mitkSurface.cpp.

References ClearData().

◆ Surface() [2/2]

mitk::Surface::Surface ( const Surface other)
protected

Definition at line 42 of file mitkSurface.cpp.

References DeepCopy(), and InitializeEmpty().

Member Function Documentation

◆ CalculateBoundingBox()

void mitk::Surface::CalculateBoundingBox ( )

◆ ClearData()

void mitk::Surface::ClearData ( )
overrideprotectedvirtual

reset to non-initialized state, release memory

Reimplemented from mitk::BaseData.

Definition at line 78 of file mitkSurface.cpp.

References mitk::BaseData::ClearData().

Referenced by InitializeEmpty(), and ~Surface().

◆ Clone()

Pointer mitk::Surface::Clone ( ) const

◆ CopyInformation()

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

Definition at line 250 of file mitkSurface.cpp.

References mitk::BaseData::CopyInformation(), and mitkThrow.

Referenced by Graft().

◆ ExecuteOperation()

void mitk::Surface::ExecuteOperation ( Operation operation)
overridevirtual

overwrite if the Data can be called by an Interactor (StateMachine).

Empty by default. Overwrite and implement all the necessary operations here and get the necessary information from the parameter operation.

Reimplemented from mitk::BaseData.

Definition at line 283 of file mitkSurface.cpp.

References CalculateBoundingBox(), mitk::Operation::GetOperationType(), mitk::SurfaceOperation::GetTimeStep(), mitk::OpSURFACECHANGED, and SetVtkPolyData().

◆ Expand()

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

Definition at line 272 of file mitkSurface.cpp.

References mitk::BaseData::Expand().

Referenced by mitk::ContourModelToSurfaceFilter::GenerateData(), and SetVtkPolyData().

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::Surface::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::BaseData.

Definition at line 33 of file mitkSurface.h.

◆ GetClassName()

virtual const char* mitk::Surface::GetClassName ( ) const
virtual

Reimplemented from mitk::BaseData.

◆ GetLargestPossibleRegion()

const mitk::Surface::RegionType & mitk::Surface::GetLargestPossibleRegion ( ) const

◆ GetRequestedRegion()

const mitk::Surface::RegionType & mitk::Surface::GetRequestedRegion ( ) const
virtual

Definition at line 93 of file mitkSurface.cpp.

◆ GetSizeOfPolyDataSeries()

unsigned int mitk::Surface::GetSizeOfPolyDataSeries ( ) const

Definition at line 316 of file mitkSurface.cpp.

Referenced by mitk::Equal().

◆ GetStaticNameOfClass()

static const char* mitk::Surface::GetStaticNameOfClass ( )
inlinestatic

◆ GetVtkPolyData()

◆ Graft()

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

Definition at line 321 of file mitkSurface.cpp.

References CopyInformation(), and mitkThrow.

◆ InitializeEmpty()

void mitk::Surface::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 98 of file mitkSurface.cpp.

References ClearData(), mitk::BaseData::InitializeTimeGeometry(), and mitk::BaseData::m_Initialized.

Referenced by Surface().

◆ InternalClone()

virtual itk::LightObject::Pointer mitk::Surface::InternalClone ( ) const
inlineoverrideprotectedvirtual

Definition at line 58 of file mitkSurface.h.

◆ IsEmptyTimeStep()

bool mitk::Surface::IsEmptyTimeStep ( unsigned int  t) const
overridevirtual

Check whether object contains data (at a specified time), e.g., a set of points may be empty.

Warning
Returns IsInitialized()==false by default for compatibility reasons. Override in sub-classes that support distinction between empty/non-empty state.

Reimplemented from mitk::BaseData.

Definition at line 130 of file mitkSurface.cpp.

References GetVtkPolyData(), and mitk::BaseData::IsInitialized().

◆ New()

◆ operator=()

mitk::Surface & mitk::Surface::operator= ( Surface  other)
protected

Definition at line 67 of file mitkSurface.cpp.

References Swap().

◆ PrintSelf()

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

Definition at line 338 of file mitkSurface.cpp.

References mitk::BaseData::PrintSelf().

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

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

Definition at line 207 of file mitkSurface.cpp.

◆ SetRequestedRegion() [1/2]

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

Definition at line 232 of file mitkSurface.cpp.

References mitkThrow.

◆ SetRequestedRegion() [2/2]

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

Definition at line 242 of file mitkSurface.cpp.

References mitkThrow.

◆ SetRequestedRegionToLargestPossibleRegion()

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

Definition at line 202 of file mitkSurface.cpp.

References GetLargestPossibleRegion().

◆ SetVtkPolyData()

◆ Swap()

void mitk::Surface::Swap ( mitk::Surface other)
virtual

Definition at line 59 of file mitkSurface.cpp.

References swap().

Referenced by operator=().

◆ Update()

void mitk::Surface::Update ( )
override

Definition at line 262 of file mitkSurface.cpp.

References mitk::BaseData::GetSource(), and Update().

◆ UpdateOutputInformation()

void mitk::Surface::UpdateOutputInformation ( )
override

◆ VerifyRequestedRegion()

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

Reimplemented in mitk::BoundingObjectGroup.

Definition at line 223 of file mitkSurface.cpp.


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