itk::CheckerBoardImageFilter< TImage > Class Template Reference
[Intensity Image Filters, Multithreaded Filters]

Combines two images in a checkerboard pattern. More...

#include <itkCheckerBoardImageFilter.h>

Inheritance diagram for itk::CheckerBoardImageFilter< TImage >:

[legend]Collaboration diagram for itk::CheckerBoardImageFilter< TImage >:

[legend]List of all members.

Public Types
typedef CheckerBoardImageFilter	Self
typedef ImageToImageFilter< TImage, TImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TImage	InputImageType
typedef TImage	OutputImageType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	ImageRegionType
typedef FixedArray< unsigned int,::itk::GetImageDimension< TImage >::ImageDimension >	PatternArrayType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
void	SetInput1 (const TImage *image1)
void	SetInput2 (const TImage *image2)
virtual void	SetCheckerPattern (PatternArrayType _arg)
virtual const PatternArrayType &	GetCheckerPattern ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	CheckerBoardImageFilter ()
	~CheckerBoardImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const ImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

template<class TImage>
class itk::CheckerBoardImageFilter< TImage >

Combines two images in a checkerboard pattern.

CheckerBoardImageFilter takes two input images that must have the same dimension, size, origin and spacing and produces an output image of the same size by combinining the pixels from the two input images in a checkerboard pattern. This filter is commonly used for visually comparing two images, in particular for evaluating the results of an image registration process.

This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

Definition at line 40 of file itkCheckerBoardImageFilter.h.

---

Member Typedef Documentation

template<class TImage> typedef SmartPointer<const Self> itk::CheckerBoardImageFilter< TImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 48 of file itkCheckerBoardImageFilter.h.

template<class TImage> typedef OutputImageType::RegionType itk::CheckerBoardImageFilter< TImage >::ImageRegionType

Definition at line 53 of file itkCheckerBoardImageFilter.h. Referenced by itk::CheckerBoardImageFilter< TImage >::~CheckerBoardImageFilter().

template<class TImage> typedef InputImageType::ConstPointer itk::CheckerBoardImageFilter< TImage >::InputImageConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 51 of file itkCheckerBoardImageFilter.h.

template<class TImage> typedef TImage itk::CheckerBoardImageFilter< TImage >::InputImageType

Some convenient typedefs. Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 49 of file itkCheckerBoardImageFilter.h.

template<class TImage> typedef OutputImageType::Pointer itk::CheckerBoardImageFilter< TImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TImage >. Definition at line 52 of file itkCheckerBoardImageFilter.h.

template<class TImage> typedef TImage itk::CheckerBoardImageFilter< TImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TImage >. Definition at line 50 of file itkCheckerBoardImageFilter.h.

template<class TImage> typedef FixedArray< unsigned int, ::itk::GetImageDimension<TImage>::ImageDimension > itk::CheckerBoardImageFilter< TImage >::PatternArrayType

Type to hold the number of checker boxes per dimension Definition at line 67 of file itkCheckerBoardImageFilter.h. Referenced by itk::CheckerBoardImageFilter< TImage >::~CheckerBoardImageFilter().

template<class TImage> typedef SmartPointer<Self> itk::CheckerBoardImageFilter< TImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 47 of file itkCheckerBoardImageFilter.h.

template<class TImage> typedef CheckerBoardImageFilter itk::CheckerBoardImageFilter< TImage >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 45 of file itkCheckerBoardImageFilter.h. Referenced by itk::CheckerBoardImageFilter< TImage >::~CheckerBoardImageFilter().

template<class TImage> typedef ImageToImageFilter<TImage,TImage> itk::CheckerBoardImageFilter< TImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TImage, TImage >. Definition at line 46 of file itkCheckerBoardImageFilter.h.

---

Constructor & Destructor Documentation

template<class TImage> itk::CheckerBoardImageFilter< TImage >::CheckerBoardImageFilter (   )  [protected]

template<class TImage> itk::CheckerBoardImageFilter< TImage >::~CheckerBoardImageFilter (   )  [inline, protected]

Definition at line 83 of file itkCheckerBoardImageFilter.h. References itk::CheckerBoardImageFilter< TImage >::ImageRegionType, itk::CheckerBoardImageFilter< TImage >::PatternArrayType, and itk::CheckerBoardImageFilter< TImage >::Self.

---

Member Function Documentation

template<class TImage> virtual const PatternArrayType& itk::CheckerBoardImageFilter< TImage >::GetCheckerPattern (   )  [virtual]

Set Checker pattern

template<class TImage> virtual const char* itk::CheckerBoardImageFilter< TImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage> itk::CheckerBoardImageFilter< TImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TImage::ImageDimension  )

Number of dimensions.

template<class TImage> Pointer itk::CheckerBoardImageFilter< TImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TImage> void itk::CheckerBoardImageFilter< TImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [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::ImageToImageFilter< TImage, TImage >.

template<class TImage> virtual void itk::CheckerBoardImageFilter< TImage >::SetCheckerPattern (  PatternArrayType  _arg  )  [virtual]

Set Checker pattern

template<class TImage> void itk::CheckerBoardImageFilter< TImage >::SetInput1 (  const TImage *  image1  )

Connect one of the operands for checker board

template<class TImage> void itk::CheckerBoardImageFilter< TImage >::SetInput2 (  const TImage *  image2  )

Connect one of the operands for checker board

template<class TImage> void itk::CheckerBoardImageFilter< TImage >::ThreadedGenerateData (  const ImageRegionType &  outputRegionForThread, int  threadId )  [protected]

CheckerBoardImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread" See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

---

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

• itkCheckerBoardImageFilter.h

---