ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage > Class Template Reference
Intensity Image Filters | MultiThreaded Filters | Module ITKImageIntensity

#include <itkMaskImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef TMaskImage MaskImageType
typedef SmartPointer< Self > Pointer
typedef MaskImageFilter Self
typedef
BinaryFunctorImageFilter
< TInputImage, TMaskImage,
TOutputImage,
Functor::MaskInput< typename
TInputImage::PixelType,
typename TMaskImage::PixelType,
typename
TOutputImage::PixelType > > 		Superclass

Public Member Functions

void BeforeThreadedGenerateData ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
const TOutputImage::PixelType & GetOutsideValue () const
 typedef (Concept::EqualityComparable< typename TMaskImage::PixelType >) MaskEqualityComparableCheck
 typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
void SetMaskImage (const MaskImageType *maskImage)
const MaskImageType * GetMaskImage ()
void SetOutsideValue (const typename TOutputImage::PixelType &outsideValue)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 MaskImageFilter ()
virtual ~MaskImageFilter ()

Private Member Functions

template<class TPixelType >
void CheckOutsideValue (const TPixelType *)
template<class TValue >
void CheckOutsideValue (const VariableLengthVector< TValue > *)
 MaskImageFilter (const Self &)
void operator= (const Self &)

Detailed Description

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

Mask an image with a mask. image with the 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 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 = 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 0 will not be masked out.
See also:
MaskNegatedImageFilter
Wiki Examples:

Definition at line 132 of file itkMaskImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
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 152 of file itkMaskImageFilter.h.

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

Typedefs

Definition at line 159 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
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 151 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
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 143 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
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 149 of file itkMaskImageFilter.h.

Constructor & Destructor Documentation

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

End concept checking

Definition at line 212 of file itkMaskImageFilter.h.

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

End concept checking

Definition at line 213 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageFilter ( const Self &  ) [private]

Member Function Documentation

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::BeforeThreadedGenerateData ( void  ) [inline, virtual]

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(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 195 of file itkMaskImageFilter.h.

References NULL.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
template<class TPixelType >
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue ( const TPixelType *  ) [inline, private]

Definition at line 227 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
template<class TValue >
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue ( const VariableLengthVector< TValue > *  ) [inline, private]

Definition at line 230 of file itkMaskImageFilter.h.

References itk::VariableLengthVector< TValueType >::Fill(), and itk::VariableLengthVector< TValueType >::GetSize().

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

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

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
const MaskImageType* itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskImage ( ) [inline]

Set/Get the mask image. Pixels set in the mask image will retain the original value of the input image while pixels not set in the mask will be set to the "OutsideValue".

Definition at line 173 of file itkMaskImageFilter.h.

References itk::ProcessObject::GetInput().

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
virtual const char* itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

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

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
const TOutputImage::PixelType& itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue ( ) const [inline]

Definition at line 190 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
static 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 > >.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::operator= ( const Self &  ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [inline, protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 216 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
void itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskImage ( const MaskImageType *  maskImage) [inline]

Set/Get the mask image. Pixels set in the mask image will retain the original value of the input image while pixels not set in the mask will be set to the "OutsideValue".

Definition at line 168 of file itkMaskImageFilter.h.

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

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

Definition at line 180 of file itkMaskImageFilter.h.

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::typedef ( Concept::EqualityComparable< typename TMaskImage::PixelType >  )

Begin concept checking This class requires MaskEqualityComparableCheck in the form of ( Concept::EqualityComparable< typename TMaskImage::PixelType > )

template<class TInputImage , class TMaskImage , class TOutputImage = TInputImage>
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::typedef ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >  )

This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > )

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 00:58:13 for ITK by doxygen 1.7.6.1