Medical Imaging Interaction Toolkit  2018.4.99-87d68d9f
Medical Imaging Interaction Toolkit
mitk::PlanarFigureSource Class Reference

Base class for all filters which have an object of type mitk::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 BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 

Public Member Functions

 mitkClassMacro (PlanarFigureSource, BaseDataSource)
 
Pointer Clone () const
 
mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
void GenerateInputRequestedRegion () override
 
- Public Member Functions inherited from mitk::BaseDataSource
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (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)
 
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
 Access itk::ProcessObject::m_Updating. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 PlanarFigureSource ()
 
 ~PlanarFigureSource () override
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Additional Inherited Members

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

Detailed Description

Base class for all filters which have an object of type mitk::PlanarFigure as output.

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

Definition at line 33 of file mitkPlanarFigureSource.h.

Member Typedef Documentation

◆ DataObjectPointer

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

Definition at line 42 of file mitkPlanarFigureSource.h.

◆ OutputType

◆ OutputTypePointer

Constructor & Destructor Documentation

◆ PlanarFigureSource()

mitk::PlanarFigureSource::PlanarFigureSource ( )
protected

Definition at line 17 of file mitkPlanarFigureSource.cpp.

References MakeOutput().

◆ ~PlanarFigureSource()

mitk::PlanarFigureSource::~PlanarFigureSource ( )
overrideprotected

Definition at line 25 of file mitkPlanarFigureSource.cpp.

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.

Definition at line 29 of file mitkPlanarFigureSource.cpp.

◆ MakeOutput() [1/2]

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

Allocates a new output object and returns it. Currently the index idx is not evaluated.

Parameters
idxthe index of the output for which an object should be created
Returns
the new object

Implements mitk::BaseDataSource.

Definition at line 34 of file mitkPlanarFigureSource.cpp.

References mitk::PlanarCircle::New().

Referenced by mitk::PlanarFigureToPlanarFigureFilter::CreateOutputsForAllInputs(), MakeOutput(), mitk::PlanarFigureReader::PlanarFigureReader(), PlanarFigureSource(), and mitk::PlanarFigureReader::ResizeOutputs().

◆ MakeOutput() [2/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 appopriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

Implements mitk::BaseDataSource.

Definition at line 39 of file mitkPlanarFigureSource.cpp.

References MakeOutput(), mitkBaseDataSourceGetOutputDefinitions, and mitk::PlanarCircle::New().

◆ mitkClassMacro()

mitk::PlanarFigureSource::mitkClassMacro ( PlanarFigureSource  ,
BaseDataSource   
)

◆ New()

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

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