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

#include <sitkCheckerBoardImageFilter.h>

Inheritance diagram for itk::simple::CheckerBoardImageFilter:

Collaboration diagram for itk::simple::CheckerBoardImageFilter:

Public Types
typedef NonLabelPixelIDTypeList	PixelIDTypeList

typedef CheckerBoardImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
	CheckerBoardImageFilter ()

Image	Execute (const Image &image1, const Image &image2)

Image	Execute (const Image &image1, const Image &image2, const std::vector< uint32_t > &checkerPattern)

std::vector< uint32_t >	GetCheckerPattern () const

std::string	GetName () const

Self &	SetCheckerPattern (const std::vector< uint32_t > &CheckerPattern)

Self &	SetCheckerPattern (uint32_t value)

std::string	ToString () const

virtual	~CheckerBoardImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 2 >
	ImageFilter ()

virtual	~ImageFilter ()=0

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

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1, const Image &image2)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1, const Image &image2)

Private Attributes
std::vector< uint32_t >	m_CheckerPattern

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 2 >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

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.

See also: itk::simple::CheckerBoard for the procedural interface; itk::CheckerBoardImageFilter for the Doxygen on the original ITK class.

Definition at line 44 of file sitkCheckerBoardImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::CheckerBoardImageFilter::MemberFunctionType) (const Image &image1, const Image &image2)

private

Setup for member function dispatching

Definition at line 91 of file sitkCheckerBoardImageFilter.h.

typedef NonLabelPixelIDTypeList itk::simple::CheckerBoardImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 56 of file sitkCheckerBoardImageFilter.h.

typedef CheckerBoardImageFilter itk::simple::CheckerBoardImageFilter::Self

Definition at line 46 of file sitkCheckerBoardImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::CheckerBoardImageFilter::~CheckerBoardImageFilter ( )

virtual

Destructor

itk::simple::CheckerBoardImageFilter::CheckerBoardImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::CheckerBoardImageFilter::Execute	(	const Image &	image1,
		const Image &	image2
	)

Execute the filter on the input images

Image itk::simple::CheckerBoardImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		const std::vector< uint32_t > &	checkerPattern
	)

Execute the filter on the input images with the given parameters

template<class TImageType >

Image itk::simple::CheckerBoardImageFilter::ExecuteInternal	(	const Image &	image1,
		const Image &	image2
	)

private

std::vector<uint32_t> itk::simple::CheckerBoardImageFilter::GetCheckerPattern ( ) const

inline

Set/Get the checker pattern array, i.e. the number of checker boxes per image dimension.

Definition at line 72 of file sitkCheckerBoardImageFilter.h.

std::string itk::simple::CheckerBoardImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 74 of file sitkCheckerBoardImageFilter.h.

Self& itk::simple::CheckerBoardImageFilter::SetCheckerPattern ( const std::vector< uint32_t > & CheckerPattern )

inline

Set/Get the checker pattern array, i.e. the number of checker boxes per image dimension.

Definition at line 63 of file sitkCheckerBoardImageFilter.h.

Self& itk::simple::CheckerBoardImageFilter::SetCheckerPattern ( uint32_t value )

inline

Set the values of the CheckerPattern vector all to value

Definition at line 66 of file sitkCheckerBoardImageFilter.h.

std::string itk::simple::CheckerBoardImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 95 of file sitkCheckerBoardImageFilter.h.

Member Data Documentation

std::vector<uint32_t> itk::simple::CheckerBoardImageFilter::m_CheckerPattern

private

Definition at line 100 of file sitkCheckerBoardImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::CheckerBoardImageFilter::m_MemberFactory

private

Definition at line 97 of file sitkCheckerBoardImageFilter.h.

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

sitkCheckerBoardImageFilter.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation