mitk::MaskImageFilter Class Reference

#include <mitkMaskImageFilter.h>

Inheritance diagram for mitk::MaskImageFilter:

Collaboration diagram for mitk::MaskImageFilter:

Public Member Functions
	mitkClassMacro (MaskImageFilter, ImageToImageFilter)
Pointer	Clone () const
void	SetMask (const mitk::Image *mask)
const mitk::Image *	GetMask () const
virtual mitk::ScalarType	GetMinValue ()
virtual void	SetMinValue (mitk::ScalarType _arg)
virtual mitk::ScalarType	GetMaxValue ()
virtual void	SetMaxValue (mitk::ScalarType _arg)
virtual void	SetOutsideValue (mitk::ScalarType _arg)
virtual mitk::ScalarType	GetOutsideValue ()
virtual void	SetOverrideOutsideValue (bool _arg)
virtual bool	GetOverrideOutsideValue ()
virtual void	OverrideOutsideValueOn ()
virtual void	OverrideOutsideValueOff ()
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)
InputImageType *	GetInput (void)
InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
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
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
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 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
	MaskImageFilter ()
	~MaskImageFilter () override
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override
void	GenerateData () override
template<typename TPixel , unsigned int VImageDimension>
void	InternalComputeMask (itk::Image< TPixel, VImageDimension > *itkImage)
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
mitk::Image::Pointer	m_Mask
mitk::ImageTimeSelector::Pointer	m_InputTimeSelector
mitk::ImageTimeSelector::Pointer	m_MaskTimeSelector
mitk::ImageTimeSelector::Pointer	m_OutputTimeSelector
itk::TimeStamp	m_TimeOfHeaderInitialization
mitk::ScalarType	m_OutsideValue
mitk::ScalarType	m_MinValue
mitk::ScalarType	m_MaxValue
bool	m_OverrideOutsideValue

Additional Inherited Members
Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter	Self
typedef ImageSource	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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< 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
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

Definition at line 28 of file mitkMaskImageFilter.h.

Constructor & Destructor Documentation

MaskImageFilter()

MaskImageFilter::MaskImageFilter ( )

protected

Definition at line 26 of file mitkMaskImageFilter.cpp.

References m_InputTimeSelector, m_MaskTimeSelector, m_OutputTimeSelector, m_OutsideValue, m_OverrideOutsideValue, and mitk::ImageTimeSelector::New().

~MaskImageFilter()

MaskImageFilter::~MaskImageFilter ( )

overrideprotected

Definition at line 37 of file mitkMaskImageFilter.cpp.

Member Function Documentation

Clone()

Pointer mitk::MaskImageFilter::Clone

(

)

const

GenerateData()

void MaskImageFilter::GenerateData ( )

overrideprotected

Definition at line 198 of file mitkMaskImageFilter.cpp.

References AccessByItk, mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), InternalComputeMask(), m_InputTimeSelector, m_Mask, m_MaskTimeSelector, m_OutputTimeSelector, m_TimeOfHeaderInitialization, mask, mitk::TimeGeometry::TimePointToTimeStep(), and mitk::TimeGeometry::TimeStepToTimePoint().

GenerateInputRequestedRegion()

void MaskImageFilter::GenerateInputRequestedRegion ( )

overrideprotected

Definition at line 53 of file mitkMaskImageFilter.cpp.

References mitk::TimeGeometry::CountTimeSteps(), mitk::GenerateTimeInInputRegion(), mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), mitk::BaseData::GetTimeGeometry(), mitk::BaseData::IsInitialized(), m_Mask, mask, and mitk::SlicedData::SetRequestedRegionToLargestPossibleRegion().

GenerateOutputInformation()

void MaskImageFilter::GenerateOutputInformation ( )

overrideprotected

Definition at line 70 of file mitkMaskImageFilter.cpp.

References mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), and m_TimeOfHeaderInitialization.

GetMask()

const mitk::Image * MaskImageFilter::GetMask

(

)

const

Definition at line 48 of file mitkMaskImageFilter.cpp.

References m_Mask.

GetMaxValue()

virtual mitk::ScalarType mitk::MaskImageFilter::GetMaxValue ( )

virtual

get/set the max Value of the original image in the masked area

GetMinValue()

virtual mitk::ScalarType mitk::MaskImageFilter::GetMinValue ( )

virtual

get/set the min Value of the original image in the masked area

GetOutsideValue()

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

virtual

This value is used as outside value. This only works if OverrideOutsideValue is set to true. Default is 0.

GetOverrideOutsideValue()

virtual bool mitk::MaskImageFilter::GetOverrideOutsideValue ( )

virtual

If OverrideOutsideValue is set to false, this minimum of the pixel type of the output image is taken as outside value. If set to true, the value set via SetOutsideValue is used as background.

InternalComputeMask()

template<typename TPixel , unsigned int VImageDimension>

void MaskImageFilter::InternalComputeMask ( itk::Image< TPixel, VImageDimension > *  itkImage )

protected

Definition at line 88 of file mitkMaskImageFilter.cpp.

References mitk::PixelType::GetComponentType(), m_MaskTimeSelector, m_MaxValue, m_MinValue, m_OutputTimeSelector, m_OutsideValue, m_OverrideOutsideValue, max(), min(), and mitk::ImageToItk< TOutputImage >::New().

Referenced by GenerateData().

mitkClassMacro()

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

New()

static Pointer mitk::MaskImageFilter::New ( )

static

Referenced by mitk::MaskAndCutRoiImageFilter::MaskAndCutRoiImageFilter().

OverrideOutsideValueOff()

virtual void mitk::MaskImageFilter::OverrideOutsideValueOff ( )

virtual

OverrideOutsideValueOn()

virtual void mitk::MaskImageFilter::OverrideOutsideValueOn ( )

virtual

SetMask()

void MaskImageFilter::SetMask

(

const mitk::Image *

mask

)

Definition at line 41 of file mitkMaskImageFilter.cpp.

References m_Mask, and mask.

SetMaxValue()

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

virtual

SetMinValue()

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

virtual

SetOutsideValue()

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

virtual

This value is used as outside value. This only works if OverrideOutsideValue is set to true. Default is 0.

SetOverrideOutsideValue()

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

virtual

If OverrideOutsideValue is set to false, this minimum of the pixel type of the output image is taken as outside value. If set to true, the value set via SetOutsideValue is used as background.

Member Data Documentation

m_InputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::MaskImageFilter::m_InputTimeSelector

protected

Definition at line 95 of file mitkMaskImageFilter.h.

Referenced by GenerateData(), and MaskImageFilter().

m_Mask

mitk::Image::Pointer mitk::MaskImageFilter::m_Mask

protected

Definition at line 94 of file mitkMaskImageFilter.h.

Referenced by GenerateData(), GenerateInputRequestedRegion(), GetMask(), and SetMask().

m_MaskTimeSelector

mitk::ImageTimeSelector::Pointer mitk::MaskImageFilter::m_MaskTimeSelector

protected

Definition at line 96 of file mitkMaskImageFilter.h.

Referenced by GenerateData(), InternalComputeMask(), and MaskImageFilter().

m_MaxValue

mitk::ScalarType mitk::MaskImageFilter::m_MaxValue

protected

Definition at line 105 of file mitkMaskImageFilter.h.

Referenced by InternalComputeMask().

m_MinValue

mitk::ScalarType mitk::MaskImageFilter::m_MinValue

protected

Definition at line 104 of file mitkMaskImageFilter.h.

Referenced by InternalComputeMask().

m_OutputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::MaskImageFilter::m_OutputTimeSelector

protected

Definition at line 97 of file mitkMaskImageFilter.h.

Referenced by GenerateData(), InternalComputeMask(), and MaskImageFilter().

m_OutsideValue

mitk::ScalarType mitk::MaskImageFilter::m_OutsideValue

protected

Definition at line 103 of file mitkMaskImageFilter.h.

Referenced by InternalComputeMask(), and MaskImageFilter().

m_OverrideOutsideValue

bool mitk::MaskImageFilter::m_OverrideOutsideValue

protected

Definition at line 106 of file mitkMaskImageFilter.h.

Referenced by InternalComputeMask(), and MaskImageFilter().

m_TimeOfHeaderInitialization

itk::TimeStamp mitk::MaskImageFilter::m_TimeOfHeaderInitialization

protected

Definition at line 101 of file mitkMaskImageFilter.h.

Referenced by GenerateData(), and GenerateOutputInformation().

---

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

• mitkMaskImageFilter.h
• mitkMaskImageFilter.cpp