Converts surface data to pixel data by stamping a surface into a volume image. More...

#include <mitkSurfaceStampImageFilter.h>

Inheritance diagram for mitk::SurfaceStampImageFilter:

[legend]

Collaboration diagram for mitk::SurfaceStampImageFilter:

[legend]

Public Types
typedef itk::QuadEdgeMesh< double, 3 >	MeshType
	Mesh type used internally for surface processing. More...

Public Types inherited from mitk::ImageToImageFilter
typedef Superclass::OutputImageRegionType	OutputImageRegionType
	Superclass typedefs. More...

typedef mitk::Image	InputImageType
	Some convenient typedefs. More...

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef SlicedData::RegionType	InputImageRegionType

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...

Public Member Functions
	mitkClassMacro (SurfaceStampImageFilter, ImageToImageFilter)

virtual void	SetMakeOutputBinary (bool _arg)

virtual bool	GetMakeOutputBinary ()

virtual void	MakeOutputBinaryOn ()

virtual void	MakeOutputBinaryOff ()

virtual void	SetOverwriteBackground (bool _arg)

virtual bool	GetOverwriteBackground ()

virtual void	OverwriteBackgroundOn ()

virtual void	OverwriteBackgroundOff ()

virtual float	GetBackgroundValue () const

virtual void	SetBackgroundValue (float _arg)

virtual float	GetForegroundValue () const

virtual void	SetForegroundValue (float _arg)

void	GenerateInputRequestedRegion () override
	Generates the input requested region for the filter pipeline. More...

void	GenerateOutputInformation () override
	Generates the output information (image properties). More...

void	GenerateData () override
	Executes the surface stamping filter. More...

void	SetSurface (mitk::Surface *surface)
	Sets the surface to be stamped onto the image. More...

Public Member Functions inherited from mitk::ImageToImageFilter
	mitkClassMacro (ImageToImageFilter, ImageSource)

Pointer	Clone () const

virtual void	SetInput (const InputImageType *image)
	Set the image input of this process object. More...

virtual void	SetInput (unsigned int idx, const InputImageType *image)
	Set the image input at the specified index. More...

InputImageType *	GetInput (void)
	Get the input image (non-const). More...

InputImageType *	GetInput (unsigned int idx)
	Get the input image at the specified index (non-const). More...

const InputImageType *	GetInput (void) const
	Get the input image (const). More...

const InputImageType *	GetInput (unsigned int idx) const
	Get the input image at the specified index (const). 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::ImageToImageFilter
static Pointer	New ()
	Method for creation through the object factory. More...

Static Public Member Functions inherited from mitk::ImageSource
static Pointer	New ()
	Method for creation through the object factory. More...

Protected Member Functions
	SurfaceStampImageFilter ()

	~SurfaceStampImageFilter () override

void	SurfaceStamp (int time=0)

template<typename TPixel >
void	SurfaceStampProcessing (itk::Image< TPixel, 3 > input, MeshType mesh)

void	SurfaceStampBinaryOutputProcessing (MeshType *mesh)

Protected Member Functions inherited from mitk::ImageToImageFilter
	ImageToImageFilter ()

	~ImageToImageFilter () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	Print self information to the given stream. More...

void	GenerateInputRequestedRegion () override
	Determine the input requested region to produce the output requested region. 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_OverwriteBackground

float	m_BackgroundValue

float	m_ForegroundValue

mitk::Surface::Pointer	m_Surface

Additional Inherited Members
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 by stamping a surface into a volume image.

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) to produce a correct binary image representation of the surface in MakeOutputBinary mode.

Definition at line 46 of file mitkSurfaceStampImageFilter.h.

Member Typedef Documentation

◆ MeshType

typedef itk::QuadEdgeMesh<double, 3> mitk::SurfaceStampImageFilter::MeshType

Mesh type used internally for surface processing.

Definition at line 82 of file mitkSurfaceStampImageFilter.h.

Constructor & Destructor Documentation

◆ SurfaceStampImageFilter()

mitk::SurfaceStampImageFilter::SurfaceStampImageFilter ( )

protected

◆ ~SurfaceStampImageFilter()

mitk::SurfaceStampImageFilter::~SurfaceStampImageFilter ( )

overrideprotected

Member Function Documentation

◆ GenerateData()

void mitk::SurfaceStampImageFilter::GenerateData ( )

override

Executes the surface stamping filter.

◆ GenerateInputRequestedRegion()

void mitk::SurfaceStampImageFilter::GenerateInputRequestedRegion ( )

override

Generates the input requested region for the filter pipeline.

◆ GenerateOutputInformation()

void mitk::SurfaceStampImageFilter::GenerateOutputInformation ( )

override

Generates the output information (image properties).

◆ GetBackgroundValue()

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

virtual

◆ GetForegroundValue()

virtual float mitk::SurfaceStampImageFilter::GetForegroundValue ( ) const

virtual

◆ GetMakeOutputBinary()

virtual bool mitk::SurfaceStampImageFilter::GetMakeOutputBinary ( )

virtual

◆ GetOverwriteBackground()

virtual bool mitk::SurfaceStampImageFilter::GetOverwriteBackground ( )

virtual

◆ MakeOutputBinaryOff()

virtual void mitk::SurfaceStampImageFilter::MakeOutputBinaryOff ( )

virtual

◆ MakeOutputBinaryOn()

virtual void mitk::SurfaceStampImageFilter::MakeOutputBinaryOn ( )

virtual

◆ mitkClassMacro()

mitk::SurfaceStampImageFilter::mitkClassMacro	(	SurfaceStampImageFilter	,
		ImageToImageFilter
	)

◆ New()

static Pointer mitk::SurfaceStampImageFilter::New ( )

static

◆ OverwriteBackgroundOff()

virtual void mitk::SurfaceStampImageFilter::OverwriteBackgroundOff ( )

virtual

◆ OverwriteBackgroundOn()

virtual void mitk::SurfaceStampImageFilter::OverwriteBackgroundOn ( )

virtual

◆ SetBackgroundValue()

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

virtual

◆ SetForegroundValue()

virtual void mitk::SurfaceStampImageFilter::SetForegroundValue ( float _arg )

virtual

◆ SetMakeOutputBinary()

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

virtual

◆ SetOverwriteBackground()

virtual void mitk::SurfaceStampImageFilter::SetOverwriteBackground ( bool _arg )

virtual

◆ SetSurface()

void mitk::SurfaceStampImageFilter::SetSurface ( mitk::Surface * surface )

Sets the surface to be stamped onto the image.

Parameters

[in] surface The surface whose enclosed volume defines the stamping region.

◆ SurfaceStamp()

void mitk::SurfaceStampImageFilter::SurfaceStamp ( int time = 0 )

protected

◆ SurfaceStampBinaryOutputProcessing()

void mitk::SurfaceStampImageFilter::SurfaceStampBinaryOutputProcessing ( MeshType * mesh )

protected

◆ SurfaceStampProcessing()

template<typename TPixel >

void mitk::SurfaceStampImageFilter::SurfaceStampProcessing	(	itk::Image< TPixel, 3 > *	input,
		MeshType *	mesh
	)

protected

Member Data Documentation

◆ m_BackgroundValue

float mitk::SurfaceStampImageFilter::m_BackgroundValue

protected

Definition at line 98 of file mitkSurfaceStampImageFilter.h.

◆ m_ForegroundValue

float mitk::SurfaceStampImageFilter::m_ForegroundValue

protected

Definition at line 99 of file mitkSurfaceStampImageFilter.h.

◆ m_MakeOutputBinary

bool mitk::SurfaceStampImageFilter::m_MakeOutputBinary

protected

Definition at line 96 of file mitkSurfaceStampImageFilter.h.

◆ m_OverwriteBackground

bool mitk::SurfaceStampImageFilter::m_OverwriteBackground

protected

Definition at line 97 of file mitkSurfaceStampImageFilter.h.

◆ m_Surface

mitk::Surface::Pointer mitk::SurfaceStampImageFilter::m_Surface

protected

Definition at line 101 of file mitkSurfaceStampImageFilter.h.

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

mitkSurfaceStampImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MeshType

Constructor & Destructor Documentation

◆ SurfaceStampImageFilter()

◆ ~SurfaceStampImageFilter()

Member Function Documentation

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetBackgroundValue()

◆ GetForegroundValue()

◆ GetMakeOutputBinary()

◆ GetOverwriteBackground()

◆ MakeOutputBinaryOff()

◆ MakeOutputBinaryOn()

◆ mitkClassMacro()

◆ New()

◆ OverwriteBackgroundOff()

◆ OverwriteBackgroundOn()

◆ SetBackgroundValue()

◆ SetForegroundValue()

◆ SetMakeOutputBinary()

◆ SetOverwriteBackground()

◆ SetSurface()

◆ SurfaceStamp()

◆ SurfaceStampBinaryOutputProcessing()

◆ SurfaceStampProcessing()

Member Data Documentation

◆ m_BackgroundValue

◆ m_ForegroundValue

◆ m_MakeOutputBinary

◆ m_OverwriteBackground

◆ m_Surface