Converts surface data to pixel data. Requires a surface and an image, which header information defines the output image. More...

#include <mitkSurfaceToImageFilter.h>

Inheritance diagram for mitk::SurfaceToImageFilter:

[legend]

Collaboration diagram for mitk::SurfaceToImageFilter:

[legend]

Public Types
typedef SurfaceToImageFilter	Self

typedef ImageSource	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::ImageSource
typedef ImageSource	Self

typedef BaseDataSource	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

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 BaseDataSource	Self

typedef itk::ProcessObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef BaseData	OutputType

typedef itk::DataObject::DataObjectIdentifierType	DataObjectIdentifierType

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

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 void	GenerateInputRequestedRegion () override

virtual void	GenerateOutputInformation () override

virtual void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...

const mitk::Surface *	GetInput (void)

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

void	SetImage (const mitk::Image *source)

const mitk::Image *	GetImage (void)

Public Member Functions inherited from mitk::ImageSource
Pointer	Clone () const

OutputType *	GetOutput ()
	Get the output data of this image source object. More...

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

virtual itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Make a DataObject of the correct type to used as the specified output. More...

virtual itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual vtkImageData *	GetVtkImageData ()

virtual const vtkImageData *	GetVtkImageData () const

Public Member Functions inherited from mitk::BaseDataSource
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)

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 const char *	GetStaticNameOfClass ()

static Pointer	New ()

Static Public Member Functions inherited from mitk::ImageSource
static const char *	GetStaticNameOfClass ()

static Pointer	New ()
	Method for creation through the object factory. More...

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

Protected Member Functions
	SurfaceToImageFilter ()

virtual	~SurfaceToImageFilter ()

void	Stencil3DImage (int time=0)

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

virtual	~ImageSource ()

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

virtual 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 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 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 ()

virtual	~BaseDataSource ()

Protected Attributes
bool	m_MakeOutputBinary

bool	m_UShortBinaryPixelType

float	m_BackgroundValue

Additional Inherited Members
Static Protected Member Functions inherited from mitk::ImageSource
static 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, which 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 if he wants 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 voxel 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 50 of file mitkSurfaceToImageFilter.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::SurfaceToImageFilter::ConstPointer

Definition at line 53 of file mitkSurfaceToImageFilter.h.

typedef itk::SmartPointer<Self> mitk::SurfaceToImageFilter::Pointer

Definition at line 53 of file mitkSurfaceToImageFilter.h.

typedef SurfaceToImageFilter mitk::SurfaceToImageFilter::Self

Definition at line 53 of file mitkSurfaceToImageFilter.h.

typedef ImageSource mitk::SurfaceToImageFilter::Superclass

Definition at line 53 of file mitkSurfaceToImageFilter.h.

Constructor & Destructor Documentation

mitk::SurfaceToImageFilter::SurfaceToImageFilter ( )

protected

Definition at line 32 of file mitkSurfaceToImageFilter.cpp.

mitk::SurfaceToImageFilter::~SurfaceToImageFilter ( )

protectedvirtual

Definition at line 37 of file mitkSurfaceToImageFilter.cpp.

Member Function Documentation

Pointer mitk::SurfaceToImageFilter::Clone ( ) const

void mitk::SurfaceToImageFilter::GenerateData ( )

overridevirtual

A version of GenerateData() specific for image processing filters.

This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.