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

Superclass of all classes generating surfaces (instances of class Surface) as output. More...

#include <mitkSurfaceSource.h>

Inheritance diagram for mitk::SurfaceSource:
Collaboration diagram for mitk::SurfaceSource:

Public Types

typedef Surface OutputType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseData OutputType
 Output data type. More...
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 Identifier type for named data objects. More...
 

Public Member Functions

 mitkClassMacro (SurfaceSource, BaseDataSource)
 
Pointer Clone () const
 
mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Allocate a new output object and return it. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 Allocate a new output object by name. More...
 
- Public Member Functions inherited from mitk::BaseDataSource
 mitkClassMacroItkParent (BaseDataSource, itk::ProcessObject)
 
OutputType * GetOutput ()
 
const OutputType * GetOutput () const
 
OutputType * GetOutput (DataObjectPointerArraySizeType idx)
 
const OutputType * GetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 Graft the specified base data object onto a named output. More...
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Check whether the pipeline is currently executing. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 SurfaceSource ()
 
 ~SurfaceSource () override
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 Constructor. More...
 
 ~BaseDataSource () override
 Destructor. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

Superclass of all classes generating surfaces (instances of class Surface) as output.

In ITK and VTK the generated result of a ProcessObject is only guaranteed to be up-to-date when Update() of the ProcessObject or the generated DataObject is called immediately before access of the data stored in the DataObject. This is also true for subclasses of mitk::BaseProcess and thus for mitk::SurfaceSource.

Definition at line 34 of file mitkSurfaceSource.h.

Member Typedef Documentation

◆ OutputType

Definition at line 41 of file mitkSurfaceSource.h.

Constructor & Destructor Documentation

◆ SurfaceSource()

mitk::SurfaceSource::SurfaceSource ( )
protected

◆ ~SurfaceSource()

mitk::SurfaceSource::~SurfaceSource ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::SurfaceSource::Clone ( ) const

◆ MakeOutput() [1/2]

itk::DataObject::Pointer mitk::SurfaceSource::MakeOutput ( const DataObjectIdentifierType &  name)
overridevirtual

Allocate a new output object by name.

This is a default implementation to make sure we have something. Once all the subclasses of ProcessObject provide an appropriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

Parameters
[in]namethe identifier of the output.
Returns
The new output object.

Implements mitk::BaseDataSource.

◆ MakeOutput() [2/2]

mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer mitk::SurfaceSource::MakeOutput ( DataObjectPointerArraySizeType  idx)
overridevirtual

Allocate a new output object and return it.

Currently the index idx is not evaluated.

Parameters
[in]idxthe index of the output for which an object should be created.
Returns
The new output object.

Implements mitk::BaseDataSource.

◆ mitkClassMacro()

mitk::SurfaceSource::mitkClassMacro ( SurfaceSource  ,
BaseDataSource   
)

◆ New()

static Pointer mitk::SurfaceSource::New ( )
static

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