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

#include <itkCheckerBoardImageFilter.h>

Inheritance diagram for itk::CheckerBoardImageFilter< TImage >:

Collaboration diagram for itk::CheckerBoardImageFilter< TImage >:

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

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.

Wiki Examples:

All Examples

Combine two images by alternating blocks of a checkerboard pattern

Definition at line 45 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 53 of file itkCheckerBoardImageFilter.h.

template<class TImage >

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

Definition at line 59 of file itkCheckerBoardImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 57 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 55 of file itkCheckerBoardImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageSource< TImage >.

Definition at line 58 of file itkCheckerBoardImageFilter.h.

template<class TImage >

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

Some convenient typedefs.

Reimplemented from itk::ImageSource< TImage >.

Definition at line 56 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 73 of file itkCheckerBoardImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 52 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 50 of file itkCheckerBoardImageFilter.h.

template<class TImage >

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

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 51 of file itkCheckerBoardImageFilter.h.

Constructor & Destructor Documentation

template<class TImage >

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

Set array with number of checks to make per image dimension

template<class TImage >

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

Set array with number of checks to make per image dimension

Definition at line 86 of file itkCheckerBoardImageFilter.h.

template<class TImage >

itk::CheckerBoardImageFilter< TImage >::CheckerBoardImageFilter ( const Self & ) [private]

Member Function Documentation

template<class TImage >

virtual::itk::LightObject::Pointer itk::CheckerBoardImageFilter< TImage >::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::Object.

template<class TImage >

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

Set array with number of checks to make per image dimension

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 >

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImage >

void itk::CheckerBoardImageFilter< TImage >::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::ImageToImageFilter< TImage, TImage >.

template<class TImage >

void itk::CheckerBoardImageFilter< TImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

Set array with number of checks to make per image dimension

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage >

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

Set array with number of checks to make per image dimension

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,
		ThreadIdType	threadId
	)		`[protected, virtual]`

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"