Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage > Class Template Reference
[Intensity Image FiltersMultithreaded 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 >:

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

Collaboration graph
[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< SelfPointer
typedef SmartPointer< const
Self
ConstPointer

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 = 0 else pixel_output_image = pixel_input_image

The pixel from the input 1 is casted 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 78 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< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

Definition at line 98 of file itkMaskImageFilter.h.

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

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

Definition at line 97 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< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

Definition at line 90 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< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.

Definition at line 96 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 104 of file itkMaskImageFilter.h.

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

Definition at line 105 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< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.


The documentation for this class was generated from the following file:
Generated at Wed Mar 30 00:41:56 2005 for ITK by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2000