#include <itkCheckerBoardImageFilter.h>

Inheritance diagram for itk::CheckerBoardImageFilter< TImage >:

Collaboration diagram for itk::CheckerBoardImageFilter< TImage >:

Detailed Description

template<typename 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:

Examples:: RegistrationITKv3/ImageRegistration2.cxx, RegistrationITKv3/ImageRegistration4.cxx, RegistrationITKv3/MultiResImageRegistration1.cxx, RegistrationITKv3/MultiResImageRegistration2.cxx, RegistrationITKv3/MultiResImageRegistration3.cxx, RegistrationITKv4/ImageRegistration2.cxx, RegistrationITKv4/ImageRegistration4.cxx, RegistrationITKv4/MultiResImageRegistration1.cxx, RegistrationITKv4/MultiResImageRegistration2.cxx, and RegistrationITKv4/MultiResImageRegistration3.cxx.

Definition at line 45 of file itkCheckerBoardImageFilter.h.

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, TImage::ImageDimension >	PatternArrayType

typedef SmartPointer< Self >	Pointer

typedef CheckerBoardImageFilter	Self

typedef ImageToImageFilter < TImage, TImage >	Superclass

Public Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TImage >	Superclass

Public Types inherited from itk::ImageSource< TImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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)


virtual void	SetCheckerPattern (PatternArrayType _arg)

virtual const PatternArrayType &	GetCheckerPattern () const

Public Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
const InputImageType *	GetInput (void) const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TImage >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput (void)

const OutputImageType *	GetOutput (void) const

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) ITK_OVERRIDE

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

NameArray	GetInputNames () const

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

DataObjectPointerArray	GetInputs ()

DataObjectPointerArray	GetOutputs ()

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = TImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TImage, TImage >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TImage >
static const unsigned int	OutputImageDimension

Protected Member Functions
	CheckerBoardImageFilter ()

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

void	ThreadedGenerateData (const ImageRegionType &outputRegionForThread, ThreadIdType threadId)

	~CheckerBoardImageFilter ()

Protected Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	GenerateInputRequestedRegion ()

	ImageToImageFilter ()

virtual void	VerifyInputInformation ()

	~ImageToImageFilter ()

void	PushBackInput (const DataObject *input)

void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual void	GenerateData () ITK_OVERRIDE

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual	~ImageSource ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

virtual void	AddOutput (DataObject *output)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

virtual void	VerifyPreconditions ()

	~ProcessObject ()

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	CheckerBoardImageFilter (const Self &)

void	operator= (const Self &)

Private Attributes
PatternArrayType	m_CheckerPattern

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Static Protected Member Functions inherited from itk::ImageSource< TImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<typename TImage >

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

Definition at line 53 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

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

Definition at line 59 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

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

Definition at line 57 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

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

Definition at line 55 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

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

Definition at line 58 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

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

Definition at line 56 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

typedef FixedArray< unsigned int, 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<typename TImage >

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

Definition at line 52 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

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

Standard class typedefs.

Definition at line 50 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

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

Definition at line 51 of file itkCheckerBoardImageFilter.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::CheckerBoardImageFilter< TImage >::CheckerBoardImageFilter ( )

protected

template<typename TImage >

itk::CheckerBoardImageFilter< TImage >::~CheckerBoardImageFilter ( )

inlineprotected

Definition at line 88 of file itkCheckerBoardImageFilter.h.

template<typename TImage >

itk::CheckerBoardImageFilter< TImage >::CheckerBoardImageFilter ( const Self & )

private

Member Function Documentation

template<typename 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<typename TImage >

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

virtual

Set array with number of checks to make per image dimension

template<typename TImage >

virtual const char* itk::CheckerBoardImageFilter< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

template<typename TImage >

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

static

Method for creation through the object factory.

template<typename TImage >

void itk::CheckerBoardImageFilter< TImage >::operator= ( const Self & )

private

template<typename TImage >

void itk::CheckerBoardImageFilter< TImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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<typename TImage >

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

virtual

Set array with number of checks to make per image dimension

template<typename TImage >

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

Connect one of the operands for checker board

template<typename TImage >

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

Connect one of the operands for checker board

template<typename TImage >

void itk::CheckerBoardImageFilter< TImage >::ThreadedGenerateData	(	const ImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)

protectedvirtual

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"