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

#include <sitkNaryAddImageFilter.h>

Inheritance diagram for itk::simple::NaryAddImageFilter:

Collaboration diagram for itk::simple::NaryAddImageFilter:

Detailed Description

Pixel-wise addition of N images.

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

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

pixel_from_image_N + pixel_from_image_(N+1)

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>( input_pixel_N + input_pixel_(N+1) )

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.

Warning: No numeric overflow checking is performed in this filter.

See also: itk::simple::NaryAdd for the procedural interface

Definition at line 64 of file sitkNaryAddImageFilter.h.

Public Types
using	PixelIDTypeList = typelist2::append<BasicPixelIDTypeList, ComplexPixelIDTypeList>::type

using	Self = NaryAddImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &image1)

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

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

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

Image	Execute (const Image &image1, const Image &image2, const Image &image3, const Image &image4, const Image &image5)

Image	Execute (const std::vector< Image > &images)

std::string	GetName () const

	NaryAddImageFilter ()

std::string	ToString () const

virtual	~NaryAddImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

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

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.

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

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

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

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands.

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

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image (Self::*)( const std::vector<Image> & )

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const std::vector< Image > &images)

Private Attributes
bool	m_InPlace {false}

std::unique_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 double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.

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

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

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

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

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) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

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

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
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 TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

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

template<class TImageType>
static Image	CastITKToImage (TImageType *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)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::NaryAddImageFilter::MemberFunctionType = Image (Self::*)( const std::vector<Image> & )

private

Setup for member function dispatching

Definition at line 105 of file sitkNaryAddImageFilter.h.

◆ PixelIDTypeList

using itk::simple::NaryAddImageFilter::PixelIDTypeList = typelist2::append<BasicPixelIDTypeList, ComplexPixelIDTypeList>::type

Define the pixels types supported by this filter

Definition at line 79 of file sitkNaryAddImageFilter.h.

◆ Self

using itk::simple::NaryAddImageFilter::Self = NaryAddImageFilter

Definition at line 68 of file sitkNaryAddImageFilter.h.

Constructor & Destructor Documentation

◆ ~NaryAddImageFilter()

virtual itk::simple::NaryAddImageFilter::~NaryAddImageFilter ( )

virtual

Destructor

◆ NaryAddImageFilter()

itk::simple::NaryAddImageFilter::NaryAddImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/6]

Image itk::simple::NaryAddImageFilter::Execute ( const Image & image1 )

◆ Execute() [2/6]

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

◆ Execute() [3/6]

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

◆ Execute() [4/6]

Image itk::simple::NaryAddImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		const Image &	image3,
		const Image &	image4 )

◆ Execute() [5/6]

Image itk::simple::NaryAddImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		const Image &	image3,
		const Image &	image4,
		const Image &	image5 )

◆ Execute() [6/6]

Image itk::simple::NaryAddImageFilter::Execute ( const std::vector< Image > & images )

Execute the filter on the input images

References itk::images.

◆ ExecuteInternal()

template<class TImageType>

Image itk::simple::NaryAddImageFilter::ExecuteInternal ( const std::vector< Image > & images )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 85 of file sitkNaryAddImageFilter.h.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 106 of file sitkNaryAddImageFilter.h.

References ExecuteInternal(), and itk::images.

Member Data Documentation

◆ m_InPlace

bool itk::simple::NaryAddImageFilter::m_InPlace {false}

private

Definition at line 116 of file sitkNaryAddImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::NaryAddImageFilter::m_MemberFactory

private

Definition at line 112 of file sitkNaryAddImageFilter.h.

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

sitkNaryAddImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~NaryAddImageFilter()

◆ NaryAddImageFilter()

Member Function Documentation

◆ Execute() [1/6]

◆ Execute() [2/6]

◆ Execute() [3/6]

◆ Execute() [4/6]

◆ Execute() [5/6]

◆ Execute() [6/6]

◆ ExecuteInternal()

◆ GetName()

◆ ToString()

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_InPlace

◆ m_MemberFactory