itk::simple::MaskImageFilter Class Reference

Mask an image with a mask. More...

#include <sitkMaskImageFilter.h>

Inheritance diagram for itk::simple::MaskImageFilter:

Collaboration diagram for itk::simple::MaskImageFilter:

Public Types
typedef NonLabelPixelIDTypeList	PixelIDTypeList
typedef MaskImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image, const Image &maskImage)
Image	Execute (const Image &image, const Image &maskImage, double outsideValue, double maskingValue)
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< 0 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
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

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

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

Private Attributes
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > >	m_DualMemberFactory
double	m_MaskingValue
double	m_OutsideValue

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
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...
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) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)
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)

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 64 of file sitkMaskImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 115 of file sitkMaskImageFilter.h.

typedef NonLabelPixelIDTypeList itk::simple::MaskImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 76 of file sitkMaskImageFilter.h.

typedef MaskImageFilter itk::simple::MaskImageFilter::Self

Definition at line 66 of file sitkMaskImageFilter.h.

Constructor & Destructor Documentation

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

virtual

Destructor

itk::simple::MaskImageFilter::MaskImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

template<class TImageType1 , class TImageType2 >

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

private

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

Execute the filter on the input image

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

Execute the filter on the input image with the given parameters

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

inline

Method to get the masking value of the mask.

Definition at line 97 of file sitkMaskImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 99 of file sitkMaskImageFilter.h.

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

inline

Definition at line 87 of file sitkMaskImageFilter.h.

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

inline

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

Definition at line 92 of file sitkMaskImageFilter.h.

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

inline

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

Definition at line 83 of file sitkMaskImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 117 of file sitkMaskImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::MaskImageFilter::m_DualMemberFactory

private

Definition at line 121 of file sitkMaskImageFilter.h.

double itk::simple::MaskImageFilter::m_MaskingValue

private

Definition at line 126 of file sitkMaskImageFilter.h.

double itk::simple::MaskImageFilter::m_OutsideValue

private

Definition at line 125 of file sitkMaskImageFilter.h.

---

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

• sitkMaskImageFilter.h