Mask an image with a mask. More...

#include <sitkMaskImageFilter.h>

Inheritance diagram for itk::simple::MaskImageFilter:

Collaboration diagram for itk::simple::MaskImageFilter:

Detailed Description

Mask an image with a mask.

This class is templated over the types of the input image type, the mask image type and the type of the output image. Numeric conversions (castings) are done by the C++ defaults.

The pixel type of the input 2 image must have a valid definition of the operator != with zero. This condition is required because internally this filter will perform the operation

if pixel_from_mask_image != masking_value
 
 pixel_output_image = pixel_input_image
 
else
 
 pixel_output_image = outside_value

The pixel from the input 1 is cast to the pixel type of the output image.

Note that the input and the mask images must be of the same size.

Warning: Any pixel value other than masking value (0 by default) will not be masked out.

See also: MaskNegatedImageFilter; itk::simple::Mask for the procedural interface; itk::MaskImageFilter for the Doxygen on the original ITK class.

Definition at line 65 of file sitkMaskImageFilter.h.

Public Types
using	PixelIDTypeList = NonLabelPixelIDTypeList

using	Self = MaskImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &image, const Image &maskImage)

Image	Execute (Image &&image, const Image &maskImage)

double	GetMaskingValue () const

std::string	GetName () const

double	GetOutsideValue () const

	MaskImageFilter ()

Self &	SetMaskingValue (double MaskingValue)

Self &	SetOutsideValue (double OutsideValue)

std::string	ToString () const

virtual	~MaskImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image(Self::)(const Image image, const Image *maskImage)

Private Member Functions
template<class TImageType1 , class TImageType2 >
Image	DualExecuteInternal (const Image image, const Image maskImage)

Private Attributes
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > >	m_DualMemberFactory

bool	m_InPlace {false}

double	m_MaskingValue {0}

double	m_OutsideValue {0}

Friends
struct	detail::DualExecuteInternalAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::MaskImageFilter::MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage )

private

Setup for member function dispatching

Definition at line 116 of file sitkMaskImageFilter.h.

◆ PixelIDTypeList

using itk::simple::MaskImageFilter::PixelIDTypeList = NonLabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 77 of file sitkMaskImageFilter.h.

◆ Self

using itk::simple::MaskImageFilter::Self = MaskImageFilter

Definition at line 67 of file sitkMaskImageFilter.h.

Constructor & Destructor Documentation

◆ ~MaskImageFilter()

virtual itk::simple::MaskImageFilter::~MaskImageFilter ( )

virtual

Destructor

◆ MaskImageFilter()

itk::simple::MaskImageFilter::MaskImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ DualExecuteInternal()

template<class TImageType1 , class TImageType2 >

Image itk::simple::MaskImageFilter::DualExecuteInternal	(	const Image *	image,
		const Image *	maskImage
	)

private

◆ Execute() [1/2]

Image itk::simple::MaskImageFilter::Execute	(	const Image &	image,
		const Image &	maskImage
	)

◆ Execute() [2/2]

Image itk::simple::MaskImageFilter::Execute	(	Image &&	image,
		const Image &	maskImage
	)

Execute the filter on the input image

◆ GetMaskingValue()

double itk::simple::MaskImageFilter::GetMaskingValue ( ) const

inline

Method to get the masking value of the mask.

Definition at line 98 of file sitkMaskImageFilter.h.

◆ GetName()

std::string itk::simple::MaskImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 101 of file sitkMaskImageFilter.h.

◆ GetOutsideValue()

double itk::simple::MaskImageFilter::GetOutsideValue ( ) const

inline

Definition at line 88 of file sitkMaskImageFilter.h.

◆ SetMaskingValue()

Self& itk::simple::MaskImageFilter::SetMaskingValue ( double MaskingValue )

inline

Method to explicitly set the masking value of the mask. Defaults to 0

Definition at line 93 of file sitkMaskImageFilter.h.

◆ SetOutsideValue()

Self& itk::simple::MaskImageFilter::SetOutsideValue ( double OutsideValue )

inline

Method to explicitly set the outside value of the mask. Defaults to 0

Definition at line 84 of file sitkMaskImageFilter.h.

◆ ToString()

std::string itk::simple::MaskImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::DualExecuteInternalAddressor< MemberFunctionType >

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 118 of file sitkMaskImageFilter.h.

Member Data Documentation

◆ m_DualMemberFactory

std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::MaskImageFilter::m_DualMemberFactory

private

Definition at line 122 of file sitkMaskImageFilter.h.

◆ m_InPlace

bool itk::simple::MaskImageFilter::m_InPlace {false}

private

Definition at line 131 of file sitkMaskImageFilter.h.

◆ m_MaskingValue

double itk::simple::MaskImageFilter::m_MaskingValue {0}

private

Definition at line 128 of file sitkMaskImageFilter.h.

◆ m_OutsideValue

double itk::simple::MaskImageFilter::m_OutsideValue {0}

private

Definition at line 126 of file sitkMaskImageFilter.h.

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

sitkMaskImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~MaskImageFilter()

◆ MaskImageFilter()

Member Function Documentation

◆ DualExecuteInternal()

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ GetMaskingValue()

◆ GetName()

◆ GetOutsideValue()

◆ SetMaskingValue()

◆ SetOutsideValue()

◆ ToString()

Friends And Related Function Documentation

◆ detail::DualExecuteInternalAddressor< MemberFunctionType >

Member Data Documentation

◆ m_DualMemberFactory

◆ m_InPlace

◆ m_MaskingValue

◆ m_OutsideValue