mitk::SurfaceToImageFilter Class Reference

Converts surface data to pixel data. More...

#include <mitkSurfaceToImageFilter.h>

Inheritance diagram for mitk::SurfaceToImageFilter:

Collaboration diagram for mitk::SurfaceToImageFilter:

Public Member Functions
	mitkClassMacro (SurfaceToImageFilter, ImageSource)
Pointer	Clone () const
virtual void	SetMakeOutputBinary (bool _arg)
virtual bool	GetMakeOutputBinary ()
virtual void	MakeOutputBinaryOn ()
virtual void	MakeOutputBinaryOff ()
virtual void	SetUShortBinaryPixelType (bool _arg)
virtual bool	GetUShortBinaryPixelType ()
virtual void	UShortBinaryPixelTypeOn ()
virtual void	UShortBinaryPixelTypeOff ()
virtual float	GetBackgroundValue () const
virtual void	SetBackgroundValue (float _arg)
virtual double	GetTolerance () const
virtual void	SetTolerance (double _arg)
void	GenerateInputRequestedRegion () override
	Generate the input requested region. More...
void	GenerateOutputInformation () override
	Generate output information based on the input image. More...
void	GenerateData () override
	Perform the surface-to-image conversion. More...
const mitk::Surface *	GetInput (void)
	Get the input surface. More...
virtual void	SetInput (const mitk::Surface *surface)
	Set the input surface to be converted. More...
void	SetImage (const mitk::Image *source)
	Set the reference image that defines the output geometry. More...
const mitk::Image *	GetImage (void)
	Get the reference image. More...
Public Member Functions inherited from mitk::ImageSource
	mitkClassMacro (ImageSource, BaseDataSource)
Pointer	Clone () const
mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Get the output data of this image source object. More...
itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override
virtual vtkImageData *	GetVtkImageData ()
	Get the output as VTK image data (non-const version). More...
virtual const vtkImageData *	GetVtkImageData () const
	Get the output as VTK image data (const version). 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::ImageSource
static Pointer	New ()
	Method for creation through the object factory. More...

Protected Member Functions
	SurfaceToImageFilter ()
	~SurfaceToImageFilter () override
void	Stencil3DImage (int time=0)
	Perform the 3D stencil operation for the given time step. More...
Protected Member Functions inherited from mitk::ImageSource
	ImageSource ()
	~ImageSource () override
void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
	If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
void	PrepareOutputs () override
	This method is intentionally left blank. More...
virtual void	AllocateOutputs ()
	The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
virtual void	BeforeThreadedGenerateData ()
	If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can provide an implementation for BeforeThreadedGenerateData(). More...
virtual void	AfterThreadedGenerateData ()
	If an imaging filter needs to perform processing after all processing threads have completed, the filter can provide an implementation for AfterThreadedGenerateData(). More...
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
	Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
Protected Member Functions inherited from mitk::BaseDataSource
	BaseDataSource ()
	Constructor. More...
	~BaseDataSource () override
	Destructor. More...

Protected Attributes
bool	m_MakeOutputBinary
bool	m_UShortBinaryPixelType
float	m_BackgroundValue
double	m_Tolerance

Additional Inherited Members
Public Types inherited from mitk::ImageSource
typedef mitk::Image	OutputImageType
	Some convenient typedefs. More...
typedef OutputImageType	OutputType
typedef OutputImageType::Pointer	OutputImagePointer
typedef SlicedData::RegionType	OutputImageRegionType
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...
Static Protected Member Functions inherited from mitk::ImageSource
static itk::ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
	Static function used as a "callback" by the MultiThreader. More...
Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer	New ()

Detailed Description

Converts surface data to pixel data.

Requires a surface and an image, whose header information defines the output image. The resulting image has the same dimension, size, and Geometry3D as the input image. The image is cut using a vtkStencil. The user can decide whether to keep the original values or create a binary image by setting MakeBinaryOutputOn (default is false). If set to true, all voxels inside the surface are set to one and all outside voxels are set to zero.

Note

Since the reference input image is passed to the vtkStencil in any case, the image needs to be initialized with pixel values greater than the numerical minimum of the used pixel type (e.g. at least -127 for unsigned char images, etc.) to produce a correct binary image representation of the surface in MakeOutputBinary mode.

Definition at line 44 of file mitkSurfaceToImageFilter.h.

Constructor & Destructor Documentation

SurfaceToImageFilter()

mitk::SurfaceToImageFilter::SurfaceToImageFilter ( )

protected

~SurfaceToImageFilter()

mitk::SurfaceToImageFilter::~SurfaceToImageFilter ( )

overrideprotected

Member Function Documentation

Clone()

Pointer mitk::SurfaceToImageFilter::Clone

(

)

const

GenerateData()

void mitk::SurfaceToImageFilter::GenerateData ( )

override

Perform the surface-to-image conversion.

GenerateInputRequestedRegion()

void mitk::SurfaceToImageFilter::GenerateInputRequestedRegion ( )

override

Generate the input requested region.

GenerateOutputInformation()

void mitk::SurfaceToImageFilter::GenerateOutputInformation ( )

override

Generate output information based on the input image.

GetBackgroundValue()

virtual float mitk::SurfaceToImageFilter::GetBackgroundValue ( ) const

virtual

GetImage()

const mitk::Image* mitk::SurfaceToImageFilter::GetImage

(

void

)

Get the reference image.

Returns

Pointer to the reference image, or nullptr if none is set.

GetInput()

const mitk::Surface* mitk::SurfaceToImageFilter::GetInput

(

void

)

Get the input surface.

Returns

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

GetMakeOutputBinary()

virtual bool mitk::SurfaceToImageFilter::GetMakeOutputBinary ( )

virtual

GetTolerance()

virtual double mitk::SurfaceToImageFilter::GetTolerance ( ) const

virtual

GetUShortBinaryPixelType()

virtual bool mitk::SurfaceToImageFilter::GetUShortBinaryPixelType ( )

virtual

MakeOutputBinaryOff()

virtual void mitk::SurfaceToImageFilter::MakeOutputBinaryOff ( )

virtual

MakeOutputBinaryOn()

virtual void mitk::SurfaceToImageFilter::MakeOutputBinaryOn ( )

virtual

mitkClassMacro()

mitk::SurfaceToImageFilter::mitkClassMacro	(	SurfaceToImageFilter	,
		ImageSource
	)

New()

static Pointer mitk::SurfaceToImageFilter::New ( )

static

SetBackgroundValue()

virtual void mitk::SurfaceToImageFilter::SetBackgroundValue ( float  _arg )

virtual

SetImage()

void mitk::SurfaceToImageFilter::SetImage

(

const mitk::Image *

source

)

Set the reference image that defines the output geometry.

Parameters

[in]

source

the reference image.

SetInput()

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

virtual

Set the input surface to be converted.

Parameters

[in]

surface

the surface to convert.

SetMakeOutputBinary()

virtual void mitk::SurfaceToImageFilter::SetMakeOutputBinary ( bool  _arg )

virtual

SetTolerance()

virtual void mitk::SurfaceToImageFilter::SetTolerance ( double  _arg )

virtual

SetUShortBinaryPixelType()

virtual void mitk::SurfaceToImageFilter::SetUShortBinaryPixelType ( bool  _arg )

virtual

Stencil3DImage()

void mitk::SurfaceToImageFilter::Stencil3DImage ( int  time = 0 )

protected

Perform the 3D stencil operation for the given time step.

Parameters

[in]

time

the time step to process.

UShortBinaryPixelTypeOff()

virtual void mitk::SurfaceToImageFilter::UShortBinaryPixelTypeOff ( )

virtual

UShortBinaryPixelTypeOn()

virtual void mitk::SurfaceToImageFilter::UShortBinaryPixelTypeOn ( )

virtual

Member Data Documentation

m_BackgroundValue

float mitk::SurfaceToImageFilter::m_BackgroundValue

protected

Definition at line 116 of file mitkSurfaceToImageFilter.h.

m_MakeOutputBinary

bool mitk::SurfaceToImageFilter::m_MakeOutputBinary

protected

Definition at line 113 of file mitkSurfaceToImageFilter.h.

m_Tolerance

double mitk::SurfaceToImageFilter::m_Tolerance

protected

Definition at line 117 of file mitkSurfaceToImageFilter.h.

m_UShortBinaryPixelType

bool mitk::SurfaceToImageFilter::m_UShortBinaryPixelType

protected

Definition at line 114 of file mitkSurfaceToImageFilter.h.

---

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

• mitkSurfaceToImageFilter.h