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

Base class for all filters producing a PlanarFigure as output. More...

#include <mitkPlanarFigureSource.h>

Inheritance diagram for mitk::PlanarFigureSource:
Collaboration diagram for mitk::PlanarFigureSource:

Public Types

typedef mitk::PlanarFigure OutputType
 
typedef OutputType::Pointer OutputTypePointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
- 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 (PlanarFigureSource, 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
 
void GenerateInputRequestedRegion () override
 
- 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

 PlanarFigureSource ()
 
 ~PlanarFigureSource () 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

Base class for all filters producing a PlanarFigure as output.

Base class for all filters which have an object of type mitk::PlanarFigure as output. PlanarFigureSources do not provide support for streaming, that is, the requested region is always the largest possible region.

Definition at line 32 of file mitkPlanarFigureSource.h.

Member Typedef Documentation

◆ DataObjectPointer

typedef itk::DataObject::Pointer mitk::PlanarFigureSource::DataObjectPointer

Definition at line 41 of file mitkPlanarFigureSource.h.

◆ OutputType

◆ OutputTypePointer

typedef OutputType::Pointer mitk::PlanarFigureSource::OutputTypePointer

Definition at line 40 of file mitkPlanarFigureSource.h.

Constructor & Destructor Documentation

◆ PlanarFigureSource()

mitk::PlanarFigureSource::PlanarFigureSource ( )
protected

◆ ~PlanarFigureSource()

mitk::PlanarFigureSource::~PlanarFigureSource ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::PlanarFigureSource::Clone ( ) const

◆ GenerateInputRequestedRegion()

void mitk::PlanarFigureSource::GenerateInputRequestedRegion ( )
override

Generates the input requested region simply by calling the equivalent method of the superclass.

◆ MakeOutput() [1/2]

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

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.

Implements mitk::BaseDataSource.

◆ MakeOutput() [2/2]

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

Allocate a new output object and return it.

Currently the index 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::PlanarFigureSource::mitkClassMacro ( PlanarFigureSource  ,
BaseDataSource   
)

◆ New()

static Pointer mitk::PlanarFigureSource::New ( )
static

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