Masks an image with a binary mask image. More...

#include <mitkMaskImageFilter.h>

Inheritance diagram for mitk::MaskImageFilter:

[legend]

Collaboration diagram for mitk::MaskImageFilter:

[legend]

Public Member Functions
	mitkClassMacro (MaskImageFilter, ImageToImageFilter)

Pointer	Clone () const

void	SetMask (const mitk::Image *mask)
	Set the binary mask image. More...

const Image *	GetMask () const
	Get the mask image (const version). More...

Image *	GetMask ()
	Get the mask image (non-const version). More...

virtual void	SetOutsideValue (mitk::ScalarType _arg)
	Set the value used for masked-out (outside) pixels. More...

virtual mitk::ScalarType	GetOutsideValue ()
	Get the value used for masked-out (outside) pixels. More...

virtual void	SetOverrideOutsideValue (bool _arg)
	Set whether to use a user-defined outside value. More...

virtual bool	GetOverrideOutsideValue ()
	Get whether the user-defined outside value is used. More...

virtual void	OverrideOutsideValueOn ()
	Toggle OverrideOutsideValue on/off. More...

virtual void	OverrideOutsideValueOff ()

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

	~MaskImageFilter () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

void	GenerateData () override

template<typename TPixel1 , unsigned int VImageDimension1, typename TPixel2 , unsigned int VImageDimension2>
void	InternalComputeMask (itk::Image< TPixel1, VImageDimension1 > itkInput, itk::Image< TPixel2, VImageDimension2 > itkMask)

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
itk::TimeStamp	m_TimeOfHeaderInitialization
	Time when header was last initialized. More...

mitk::ScalarType	m_OutsideValue

TimeStepType	m_CurrentOutputTS

bool	m_OverrideOutsideValue

Additional Inherited Members
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...

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

Masks an image with a binary mask image.

This filter applies a binary mask to an input image. Pixels where the mask is non-zero retain their original values, while pixels where the mask is zero are set to an outside value. By default, the outside value is the minimum of the output pixel type, but it can be overridden to a user-defined value.

The filter works on 3D images and processes each time step independently. Both the input image and the mask must have compatible dimensions.

See also: MaskAndCutRoiImageFilter

Definition at line 38 of file mitkMaskImageFilter.h.

Constructor & Destructor Documentation

◆ MaskImageFilter()

mitk::MaskImageFilter::MaskImageFilter ( )

protected

◆ ~MaskImageFilter()

mitk::MaskImageFilter::~MaskImageFilter ( )

overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::MaskImageFilter::Clone ( ) const

◆ GenerateData()

void mitk::MaskImageFilter::GenerateData ( )

overrideprotected

◆ GenerateInputRequestedRegion()

void mitk::MaskImageFilter::GenerateInputRequestedRegion ( )

overrideprotected

◆ GenerateOutputInformation()

void mitk::MaskImageFilter::GenerateOutputInformation ( )

overrideprotected

◆ GetMask() [1/2]

Image* mitk::MaskImageFilter::GetMask ( )

Get the mask image (non-const version).

Returns: Pointer to the mask image.

◆ GetMask() [2/2]

const Image* mitk::MaskImageFilter::GetMask ( ) const

Get the mask image (const version).

Returns: Const pointer to the mask image.

◆ GetOutsideValue()

virtual mitk::ScalarType mitk::MaskImageFilter::GetOutsideValue ( )

virtual

Get the value used for masked-out (outside) pixels.

Returns: The outside pixel value.

◆ GetOverrideOutsideValue()

virtual bool mitk::MaskImageFilter::GetOverrideOutsideValue ( )

virtual

Get whether the user-defined outside value is used.

Returns: True if OverrideOutsideValue is enabled.

◆ InternalComputeMask()

template<typename TPixel1 , unsigned int VImageDimension1, typename TPixel2 , unsigned int VImageDimension2>

void mitk::MaskImageFilter::InternalComputeMask	(	itk::Image< TPixel1, VImageDimension1 > *	itkInput,
		itk::Image< TPixel2, VImageDimension2 > *	itkMask
	)

protected

◆ mitkClassMacro()

mitk::MaskImageFilter::mitkClassMacro	(	MaskImageFilter	,
		ImageToImageFilter
	)

◆ New()

static Pointer mitk::MaskImageFilter::New ( )

static

◆ OverrideOutsideValueOff()

virtual void mitk::MaskImageFilter::OverrideOutsideValueOff ( )

virtual

◆ OverrideOutsideValueOn()

virtual void mitk::MaskImageFilter::OverrideOutsideValueOn ( )

virtual

Toggle OverrideOutsideValue on/off.

◆ SetMask()

void mitk::MaskImageFilter::SetMask ( const mitk::Image * mask )

Set the binary mask image.

The mask is stored as the second input (index 1) of this filter.

Parameters

[in] mask The binary mask image.

◆ SetOutsideValue()

virtual void mitk::MaskImageFilter::SetOutsideValue ( mitk::ScalarType _arg )

virtual

Set the value used for masked-out (outside) pixels.

Only effective when OverrideOutsideValue is true. Default is 0.

Parameters

[in] _arg The outside pixel value.

◆ SetOverrideOutsideValue()

virtual void mitk::MaskImageFilter::SetOverrideOutsideValue ( bool _arg )

virtual

Set whether to use a user-defined outside value.

If false (default), the minimum of the output pixel type is used. If true, the value set via SetOutsideValue is used.

Parameters

[in] _arg True to use the user-defined outside value.

Member Data Documentation

◆ m_CurrentOutputTS

TimeStepType mitk::MaskImageFilter::m_CurrentOutputTS

protected

Definition at line 120 of file mitkMaskImageFilter.h.

◆ m_OutsideValue

mitk::ScalarType mitk::MaskImageFilter::m_OutsideValue

protected

Definition at line 119 of file mitkMaskImageFilter.h.

◆ m_OverrideOutsideValue

bool mitk::MaskImageFilter::m_OverrideOutsideValue

protected

Definition at line 121 of file mitkMaskImageFilter.h.

◆ m_TimeOfHeaderInitialization

itk::TimeStamp mitk::MaskImageFilter::m_TimeOfHeaderInitialization

protected

Time when header was last initialized.

Definition at line 117 of file mitkMaskImageFilter.h.

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

mitkMaskImageFilter.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MaskImageFilter()

◆ ~MaskImageFilter()

Member Function Documentation

◆ Clone()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetMask() [1/2]

◆ GetMask() [2/2]

◆ GetOutsideValue()

◆ GetOverrideOutsideValue()

◆ InternalComputeMask()

◆ mitkClassMacro()

◆ New()

◆ OverrideOutsideValueOff()

◆ OverrideOutsideValueOn()

◆ SetMask()

◆ SetOutsideValue()

◆ SetOverrideOutsideValue()

Member Data Documentation

◆ m_CurrentOutputTS

◆ m_OutsideValue

◆ m_OverrideOutsideValue

◆ m_TimeOfHeaderInitialization