Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::SurfaceStampImageFilter Class Reference

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

#include <mitkSurfaceStampImageFilter.h>

Inheritance diagram for mitk::SurfaceStampImageFilter:
Collaboration diagram for mitk::SurfaceStampImageFilter:

Public Types

typedef itk::QuadEdgeMesh< double, 3 > MeshType
 
- Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter Self
 
typedef ImageSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef mitk::Image InputImageType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef SlicedData::RegionType InputImageRegionType
 
- Public Types inherited from mitk::ImageSource
typedef ImageSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 

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)
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateData ()
 A version of GenerateData() specific for image processing filters. More...
 
void SetSurface (mitk::Surface *surface)
 
- Public Member Functions inherited from mitk::ImageToImageFilter
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const InputImageType *image)
 
InputImageTypeGetInput (void)
 
InputImageTypeGetInput (unsigned int idx)
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
- Public Member Functions inherited from mitk::ImageSource
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (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
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...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ImageToImageFilter
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

 SurfaceStampImageFilter ()
 
virtual ~SurfaceStampImageFilter ()
 
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 ()
 
virtual ~ImageToImageFilter ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- 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_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_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 52 of file mitkSurfaceStampImageFilter.h.

Member Typedef Documentation

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

Definition at line 80 of file mitkSurfaceStampImageFilter.h.

Constructor & Destructor Documentation

mitk::SurfaceStampImageFilter::SurfaceStampImageFilter ( )
protected

Definition at line 32 of file mitkSurfaceStampImageFilter.cpp.

mitk::SurfaceStampImageFilter::~SurfaceStampImageFilter ( )
protectedvirtual

Definition at line 37 of file mitkSurfaceStampImageFilter.cpp.

Member Function Documentation

void mitk::SurfaceStampImageFilter::GenerateData ( )
virtual

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.

See also
ThreadedGenerateData()

Reimplemented from mitk::ImageSource.

Definition at line 73 of file mitkSurfaceStampImageFilter.cpp.

void mitk::SurfaceStampImageFilter::GenerateInputRequestedRegion ( )
virtual

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

Reimplemented from mitk::ImageToImageFilter.

Definition at line 41 of file mitkSurfaceStampImageFilter.cpp.

References mitk::GenerateTimeInInputRegion(), and mitk::BaseData::IsInitialized().

void mitk::SurfaceStampImageFilter::GenerateOutputInformation ( void  )
virtual

Definition at line 50 of file mitkSurfaceStampImageFilter.cpp.

virtual float mitk::SurfaceStampImageFilter::GetBackgroundValue ( ) const
virtual
virtual float mitk::SurfaceStampImageFilter::GetForegroundValue ( ) const
virtual
virtual bool mitk::SurfaceStampImageFilter::GetMakeOutputBinary ( )
virtual
virtual bool mitk::SurfaceStampImageFilter::GetOverwriteBackground ( )
virtual
virtual void mitk::SurfaceStampImageFilter::MakeOutputBinaryOff ( )
virtual
virtual void mitk::SurfaceStampImageFilter::MakeOutputBinaryOn ( )
virtual
mitk::SurfaceStampImageFilter::mitkClassMacro ( SurfaceStampImageFilter  ,
ImageToImageFilter   
)
static Pointer mitk::SurfaceStampImageFilter::New ( )
static
virtual void mitk::SurfaceStampImageFilter::OverwriteBackgroundOff ( )
virtual
virtual void mitk::SurfaceStampImageFilter::OverwriteBackgroundOn ( )
virtual
virtual void mitk::SurfaceStampImageFilter::SetBackgroundValue ( float  _arg)
virtual
virtual void mitk::SurfaceStampImageFilter::SetForegroundValue ( float  _arg)
virtual
virtual void mitk::SurfaceStampImageFilter::SetMakeOutputBinary ( bool  _arg)
virtual
virtual void mitk::SurfaceStampImageFilter::SetOverwriteBackground ( bool  _arg)
virtual
void mitk::SurfaceStampImageFilter::SetSurface ( mitk::Surface surface)

Definition at line 68 of file mitkSurfaceStampImageFilter.cpp.

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

Definition at line 231 of file mitkSurfaceStampImageFilter.cpp.

References mitk::CastToItkImage(), and mitk::New().

Member Data Documentation

float mitk::SurfaceStampImageFilter::m_BackgroundValue
protected

Definition at line 96 of file mitkSurfaceStampImageFilter.h.

float mitk::SurfaceStampImageFilter::m_ForegroundValue
protected

Definition at line 97 of file mitkSurfaceStampImageFilter.h.

bool mitk::SurfaceStampImageFilter::m_MakeOutputBinary
protected

Definition at line 94 of file mitkSurfaceStampImageFilter.h.

bool mitk::SurfaceStampImageFilter::m_OverwriteBackground
protected

Definition at line 95 of file mitkSurfaceStampImageFilter.h.

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

Definition at line 99 of file mitkSurfaceStampImageFilter.h.


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