mitk::SurfaceToSurfaceFilter Class Reference

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

#include <mitkSurfaceToSurfaceFilter.h>

Inheritance diagram for mitk::SurfaceToSurfaceFilter:

Collaboration diagram for mitk::SurfaceToSurfaceFilter:

Public Types
typedef itk::DataObject::Pointer	DataObjectPointer
Public Types inherited from mitk::SurfaceSource
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 (SurfaceToSurfaceFilter, mitk::SurfaceSource)
Pointer	Clone () const
virtual void	SetInput (const mitk::Surface *surface)
	Set the input surface at index 0. More...
virtual void	SetInput (unsigned int idx, const mitk::Surface *surface)
	Set the input surface at the given index. More...
virtual const mitk::Surface *	GetInput ()
	Get the input surface at index 0. More...
virtual const mitk::Surface *	GetInput (unsigned int idx)
	Get the input surface at the given index. More...
virtual void	CreateOutputForInput (unsigned int idx)
	Create a new output for the input at the given index. More...
virtual void	CreateOutputsForAllInputs ()
	Create outputs for all existing inputs. More...
virtual void	RemoveInputs (mitk::Surface *surface)
	Remove all inputs matching the given surface. More...
Public Member Functions inherited from mitk::SurfaceSource
	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 ()
Static Public Member Functions inherited from mitk::SurfaceSource
static Pointer	New ()

Protected Member Functions
	SurfaceToSurfaceFilter ()
	~SurfaceToSurfaceFilter () override
Protected Member Functions inherited from mitk::SurfaceSource
	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 getting surfaces (instances of class Surface) as input and generating surfaces 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::SurfaceToSurfaceFilter.

Definition at line 33 of file mitkSurfaceToSurfaceFilter.h.

Member Typedef Documentation

DataObjectPointer

typedef itk::DataObject::Pointer mitk::SurfaceToSurfaceFilter::DataObjectPointer

Definition at line 42 of file mitkSurfaceToSurfaceFilter.h.

Constructor & Destructor Documentation

SurfaceToSurfaceFilter()

mitk::SurfaceToSurfaceFilter::SurfaceToSurfaceFilter ( )

protected

~SurfaceToSurfaceFilter()

mitk::SurfaceToSurfaceFilter::~SurfaceToSurfaceFilter ( )

overrideprotected

Member Function Documentation

Clone()

Pointer mitk::SurfaceToSurfaceFilter::Clone

(

)

const

CreateOutputForInput()

virtual void mitk::SurfaceToSurfaceFilter::CreateOutputForInput ( unsigned int  idx )

virtual

Create a new output for the input at the given index.

Parameters

[in]

idx

the index of the input for which the output should be created.

Exceptions

mitk::Exception

if the input at idx does not exist.

CreateOutputsForAllInputs()

virtual void mitk::SurfaceToSurfaceFilter::CreateOutputsForAllInputs ( )

virtual

Create outputs for all existing inputs.

For each existing input, a new output will be allocated if one does not already exist.

GetInput() [1/2]

virtual const mitk::Surface* mitk::SurfaceToSurfaceFilter::GetInput ( )

virtual

Get the input surface at index 0.

Returns

Pointer to the input surface, or nullptr if none is set.

GetInput() [2/2]

virtual const mitk::Surface* mitk::SurfaceToSurfaceFilter::GetInput ( unsigned int  idx )

virtual

Get the input surface at the given index.

Parameters

[in]

idx

the index of the input.

Returns

Pointer to the input surface, or nullptr if none is set.

mitkClassMacro()

mitk::SurfaceToSurfaceFilter::mitkClassMacro	(	SurfaceToSurfaceFilter	,
		mitk::SurfaceSource
	)

New()

static Pointer mitk::SurfaceToSurfaceFilter::New ( )

static

RemoveInputs()

virtual void mitk::SurfaceToSurfaceFilter::RemoveInputs ( mitk::Surface *  surface )

virtual

Remove all inputs matching the given surface.

Parameters

[in]

surface

the surface to remove from the inputs.

SetInput() [1/2]

virtual void mitk::SurfaceToSurfaceFilter::SetInput ( const mitk::Surface *  surface )

virtual

Set the input surface at index 0.

Parameters

[in]

surface

the input surface.

Reimplemented in mitk::ReduceContourSetFilter.

SetInput() [2/2]

virtual void mitk::SurfaceToSurfaceFilter::SetInput ( unsigned int  idx, const mitk::Surface *  surface  )

virtual

Set the input surface at the given index.

Also calls CreateOutputForInput(idx) to create a corresponding output.

Note

The inputs must be added sequentially.

Parameters

[in]	idx	the index of the input, which must be incremental.
[in]	surface	the input surface to add.

Reimplemented in mitk::ReduceContourSetFilter.

---

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

• mitkSurfaceToSurfaceFilter.h