itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage > Class Template Reference
[Intensity Image Filters, Multithreaded Filters]

Implements an operator for pixel-wise masking of the input image with the mask. More...

#include <itkMaskImageFilter.h>

Inheritance diagram for itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >:

[legend]Collaboration diagram for itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef MaskImageFilter	Self
typedef BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType > >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Member Functions
void	SetOutsideValue (const typename TOutputImage::PixelType &outsudeValue)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	MaskImageFilter ()
virtual	~MaskImageFilter ()

---

Detailed Description

template<class TInputImage, class TMaskImage, class TOutputImage>
class itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >

Implements an operator for pixel-wise masking of the input image with the mask.

This class is parametrized 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 defintion of the operator != with zero. This condition is required because internally this filter will perform the operation

if pixel_from_mask_image != 0 pixel_output_image = pixel_input_image else pixel_output_image = 0

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 0 will not be masked out.

See also:

MaskNegatedImageFilter

Definition at line 93 of file itkMaskImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TMaskImage, class TOutputImage> typedef SmartPointer<const Self> itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::ConstPointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >. Definition at line 113 of file itkMaskImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage> typedef SmartPointer<Self> itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Pointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >. Definition at line 112 of file itkMaskImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage> typedef MaskImageFilter itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >. Definition at line 105 of file itkMaskImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage> typedef BinaryFunctorImageFilter<TInputImage,TMaskImage,TOutputImage, Functor::MaskInput< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType> > itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Superclass

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >. Definition at line 111 of file itkMaskImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TMaskImage, class TOutputImage> itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageFilter (   )  [inline, protected]

Definition at line 125 of file itkMaskImageFilter.h.

template<class TInputImage, class TMaskImage, class TOutputImage> virtual itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::~MaskImageFilter (   )  [inline, protected, virtual]

Definition at line 126 of file itkMaskImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TMaskImage, class TOutputImage> Pointer itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >.

template<class TInputImage, class TMaskImage, class TOutputImage> void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue (  const typename TOutputImage::PixelType &  outsudeValue  )  [inline]

Method to explicitly set the outside value of the mask. Defaults to 0 Definition at line 119 of file itkMaskImageFilter.h.

---

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

• itkMaskImageFilter.h

---