itk::simple::AddImageFilter Class Reference

Pixel-wise addition of two images. More...

#include <sitkAddImageFilter.h>

Inheritance diagram for itk::simple::AddImageFilter:

Collaboration diagram for itk::simple::AddImageFilter:

Public Types
typedef NonLabelPixelIDTypeList	PixelIDTypeList
typedef AddImageFilter	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
	AddImageFilter ()
Image	Execute (const Image &image1, const Image &image2)
Image	Execute (const Image &image1, double constant)
Image	Execute (double constant, const Image &image2)
std::string	GetName () const
std::string	ToString () const
virtual	~AddImageFilter ()
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::*	MemberFunction1Type) (double constant, const Image &image2)
typedef Image(Self::*	MemberFunction2Type) (const Image &image1, double constant)
typedef Image(Self::*	MemberFunctionType) (const Image &image1, const Image &image2)

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

Private Attributes
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunction1Type > >	m_MemberFactory1
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunction2Type > >	m_MemberFactory2

Friends
struct	detail::MemberFunctionAddressor< MemberFunction1Type >
struct	detail::MemberFunctionAddressor< MemberFunction2Type >
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

Pixel-wise addition of two images.

This class is templated over the types of the two input images and the type of the output image. Numeric conversions (castings) are done by the C++ defaults.

The pixel type of the input 1 image must have a valid definition of the operator+ with a pixel type of the image 2. This condition is required because internally this filter will perform the operation

pixel_from_image_1 + pixel_from_image_2

Additionally the type resulting from the sum, will be cast to the pixel type of the output image.

The total operation over one pixel will be

output_pixel = static_cast<OutputPixelType>( input1_pixel + input2_pixel )

For example, this filter could be used directly for adding images whose pixels are vectors of the same dimension, and to store the resulting vector in an output image of vector pixels.

The images to be added are set using the methods:

SetInput1( image1 );

SetInput2( image2 );

Additionally, this filter can be used to add a constant to every pixel of an image by using

SetInput1( image1 );

SetConstant2( constant );

Warning

No numeric overflow checking is performed in this filter.

See also

itk::simple::Add for the procedural interface

itk::AddImageFilter for the Doxygen on the original ITK class.

Definition at line 74 of file sitkAddImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::AddImageFilter::MemberFunction1Type) (double constant, const Image &image2)

private

Definition at line 116 of file sitkAddImageFilter.h.

typedef Image(Self::* itk::simple::AddImageFilter::MemberFunction2Type) (const Image &image1, double constant)

private

Definition at line 121 of file sitkAddImageFilter.h.

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

private

Setup for member function dispatching

Definition at line 109 of file sitkAddImageFilter.h.

typedef NonLabelPixelIDTypeList itk::simple::AddImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 86 of file sitkAddImageFilter.h.

typedef AddImageFilter itk::simple::AddImageFilter::Self

Definition at line 76 of file sitkAddImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::AddImageFilter::~AddImageFilter ( )

virtual

Destructor

itk::simple::AddImageFilter::AddImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input images

Image itk::simple::AddImageFilter::Execute	(	const Image &	image1,
		double	constant
	)

Execute the filter with an image and a constant

Image itk::simple::AddImageFilter::Execute	(	double	constant,
		const Image &	image2
	)

template<class TImageType >

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

private

template<class TImageType >

Image itk::simple::AddImageFilter::ExecuteInternal ( double  constant, const Image &  image2  )

private

template<class TImageType >

Image itk::simple::AddImageFilter::ExecuteInternal ( const Image &  image1, double  constant  )

private

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 90 of file sitkAddImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunction1Type >

friend

Definition at line 118 of file sitkAddImageFilter.h.

friend struct detail::MemberFunctionAddressor< MemberFunction2Type >

friend

Definition at line 123 of file sitkAddImageFilter.h.

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 113 of file sitkAddImageFilter.h.

Member Data Documentation

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

private

Definition at line 115 of file sitkAddImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunction1Type> > itk::simple::AddImageFilter::m_MemberFactory1

private

Definition at line 119 of file sitkAddImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunction2Type> > itk::simple::AddImageFilter::m_MemberFactory2

private

Definition at line 124 of file sitkAddImageFilter.h.

---

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

• sitkAddImageFilter.h