Medical Imaging Interaction Toolkit  2021.02.99-89548602
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)
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
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
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
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 ()
 
 ~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
 
void GenerateInputRequestedRegion () override
 
- 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 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 ()
 
 ~BaseDataSource () override
 

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 48 of file mitkSurfaceStampImageFilter.h.

Member Typedef Documentation

◆ MeshType

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

Definition at line 76 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

◆ GenerateInputRequestedRegion()

void mitk::SurfaceStampImageFilter::GenerateInputRequestedRegion ( )
override

◆ GenerateOutputInformation()

void mitk::SurfaceStampImageFilter::GenerateOutputInformation ( )
override

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

◆ 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 92 of file mitkSurfaceStampImageFilter.h.

◆ m_ForegroundValue

float mitk::SurfaceStampImageFilter::m_ForegroundValue
protected

Definition at line 93 of file mitkSurfaceStampImageFilter.h.

◆ m_MakeOutputBinary

bool mitk::SurfaceStampImageFilter::m_MakeOutputBinary
protected

Definition at line 90 of file mitkSurfaceStampImageFilter.h.

◆ m_OverwriteBackground

bool mitk::SurfaceStampImageFilter::m_OverwriteBackground
protected

Definition at line 91 of file mitkSurfaceStampImageFilter.h.

◆ m_Surface

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

Definition at line 95 of file mitkSurfaceStampImageFilter.h.


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