Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
mitk::ImageToPlanarFigureFilter Class Reference

Superclass of all classes having one or more Images as input and generating PlanarFigures as output. More...

#include <mitkImageToPlanarFigureFilter.h>

Inheritance diagram for mitk::ImageToPlanarFigureFilter:
Collaboration diagram for mitk::ImageToPlanarFigureFilter:

Public Types

typedef mitk::Image InputImageType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef SlicedData::RegionType InputImageRegionType
 
- Public Types inherited from mitk::PlanarFigureSource
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 (ImageToPlanarFigureFilter, PlanarFigureSource)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const InputImageType *image)
 
const InputImageTypeGetInput (void)
 
const InputImageTypeGetInput (unsigned int idx)
 
- Public Member Functions inherited from mitk::PlanarFigureSource
 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...
 

Protected Member Functions

 ImageToPlanarFigureFilter ()
 
 ~ImageToPlanarFigureFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from mitk::PlanarFigureSource
 PlanarFigureSource ()
 
 ~PlanarFigureSource () override
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Additional Inherited Members

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

Detailed Description

Superclass of all classes having one or more Images as input and generating PlanarFigures as output.

Definition at line 26 of file mitkImageToPlanarFigureFilter.h.

Member Typedef Documentation

◆ InputImageConstPointer

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

Some convenient typedefs.

Definition at line 34 of file mitkImageToPlanarFigureFilter.h.

Constructor & Destructor Documentation

◆ ImageToPlanarFigureFilter()

mitk::ImageToPlanarFigureFilter::ImageToPlanarFigureFilter ( )
protected

◆ ~ImageToPlanarFigureFilter()

mitk::ImageToPlanarFigureFilter::~ImageToPlanarFigureFilter ( )
overrideprotected

Member Function Documentation

◆ GenerateInputRequestedRegion()

void mitk::ImageToPlanarFigureFilter::GenerateInputRequestedRegion ( )
overrideprotected

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that this imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

See also
ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

◆ GetInput() [1/2]

const InputImageType* mitk::ImageToPlanarFigureFilter::GetInput ( unsigned int  idx)

◆ GetInput() [2/2]

const InputImageType* mitk::ImageToPlanarFigureFilter::GetInput ( void  )

◆ mitkClassMacro()

mitk::ImageToPlanarFigureFilter::mitkClassMacro ( ImageToPlanarFigureFilter  ,
PlanarFigureSource   
)

◆ PrintSelf()

void mitk::ImageToPlanarFigureFilter::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

◆ SetInput() [1/2]

virtual void mitk::ImageToPlanarFigureFilter::SetInput ( const InputImageType image)
virtual

◆ SetInput() [2/2]

virtual void mitk::ImageToPlanarFigureFilter::SetInput ( unsigned int  ,
const InputImageType image 
)
virtual

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