itk::NaryAddImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkNaryAddImageFilter.h>

Inheritance diagram for itk::NaryAddImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::NaryAddImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef NaryAddImageFilter	Self
typedef NaryFunctorImageFilter < TInputImage, TOutputImage, Functor::Add1< typename TInputImage::PixelType, typename TInputImage::PixelType > >	Superclass
Public Types inherited from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >
typedef Functor::Add1 < TInputImage::PixelType, TInputImage::PixelType >	FunctorType
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef std::vector < InputImagePixelType >	NaryArrayType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef InputImageType::ConstPointer	InputImageConstPointer
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
	typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck
	typedef (Concept::HasZero< typename TInputImage::PixelType >) InputHasZeroCheck
Public Member Functions inherited from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >
FunctorType &	GetFunctor ()
	typedef (Concept::SameDimension< InputImageDimension, OutputImageDimension >) SameDimensionCheck
	typedef (Concept::HasZero< OutputImagePixelType >) OutputHasZeroCheck
void	SetFunctor (FunctorType &functor)
Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const
virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace () const
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 TInputImage *image)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
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)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
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 ()
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	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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 unsigned long	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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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 ()
Protected Member Functions inherited from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >
	NaryFunctorImageFilter ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~NaryFunctorImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
virtual void	GenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
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	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) 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 ()
	NaryAddImageFilter ()
virtual	~NaryAddImageFilter ()
	NaryAddImageFilter (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Static Public Attributes inherited from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
Static Public Attributes inherited from itk::ImageSource< TOutputImage >

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::NaryAddImageFilter< TInputImage, TOutputImage >

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.

Definition at line 98 of file itkNaryAddImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef SmartPointer< const Self > itk::NaryAddImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >.

Definition at line 112 of file itkNaryAddImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::NaryAddImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >.

Definition at line 111 of file itkNaryAddImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef NaryAddImageFilter itk::NaryAddImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >.

Definition at line 105 of file itkNaryAddImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< typename TInputImage::PixelType, typename TInputImage::PixelType > > itk::NaryAddImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >.

Definition at line 109 of file itkNaryAddImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::NaryAddImageFilter< TInputImage, TOutputImage >::NaryAddImageFilter ( )

inlineprotected

End concept checking

Definition at line 132 of file itkNaryAddImageFilter.h.

template<class TInputImage , class TOutputImage >

virtual itk::NaryAddImageFilter< TInputImage, TOutputImage >::~NaryAddImageFilter ( )

inlineprotectedvirtual

End concept checking

Definition at line 133 of file itkNaryAddImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::NaryAddImageFilter< TInputImage, TOutputImage >::NaryAddImageFilter ( const Self &  )

private

End concept checking

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::NaryAddImageFilter< TInputImage, TOutputImage >::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::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >.

template<class TInputImage , class TOutputImage >

virtual const char* itk::NaryAddImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Runtime information support.

Reimplemented from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >.

template<class TInputImage , class TOutputImage >

static Pointer itk::NaryAddImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >.

template<class TInputImage , class TOutputImage >

void itk::NaryAddImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )

private

End concept checking

Reimplemented from itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Add1< TInputImage::PixelType, TInputImage::PixelType > >.

template<class TInputImage , class TOutputImage >

itk::NaryAddImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >

)

Begin concept checking This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > )

template<class TInputImage , class TOutputImage >

itk::NaryAddImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::HasZero< typename TInputImage::PixelType >

)

This class requires InputHasZeroCheck in the form of ( Concept::HasZero< typename TInputImage::PixelType > )

---

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

• itkNaryAddImageFilter.h