itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage > Class Template Reference

ITK 4.1.0

Insight Segmentation and Registration Toolkit

#include <itkAddImageFilter.h>

Inheritance diagram for itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >:

Collaboration diagram for itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef AddImageFilter	Self
typedef BinaryFunctorImageFilter < TInputImage1, TInputImage2, TOutputImage, Functor::Add2 < typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
	typedef (Concept::AdditiveOperators< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType >) Input1Input2OutputAdditiveOperatorsCheck
Static Public Member Functions
static Pointer	New ()
	AddImageFilter ()
virtual	~AddImageFilter ()
	AddImageFilter (const Self &)
void	operator= (const Self &)

Detailed Description

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
class itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >

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 defintion 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.

Wiki Examples:

All Examples

Add two images together

Add a constant to every pixel in an image

Definition at line 110 of file itkAddImageFilter.h.

Member Typedef Documentation

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

typedef SmartPointer< const Self > itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstPointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::AddConstantToImageFilter< TInputImage, TConstant, TOutputImage >.

Definition at line 129 of file itkAddImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

typedef SmartPointer< Self > itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::Pointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::AddConstantToImageFilter< TInputImage, TConstant, TOutputImage >.

Definition at line 128 of file itkAddImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

typedef AddImageFilter itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::AddConstantToImageFilter< TInputImage, TConstant, TOutputImage >.

Definition at line 121 of file itkAddImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

typedef BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > > itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::Superclass

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::AddConstantToImageFilter< TInputImage, TConstant, TOutputImage >.

Definition at line 126 of file itkAddImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::AddImageFilter ( ) [inline, protected]

End concept checking

Definition at line 148 of file itkAddImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

virtual itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::~AddImageFilter ( ) [inline, protected, virtual]

End concept checking

Definition at line 149 of file itkAddImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::AddImageFilter ( const Self & ) [private]

End concept checking

Member Function Documentation

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

virtual::itk::LightObject::Pointer itk::AddImageFilter< TInputImage1, TInputImage2, 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::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::AddConstantToImageFilter< TInputImage, TConstant, TOutputImage >.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

virtual const char* itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::AddConstantToImageFilter< TInputImage, TConstant, TOutputImage >.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

static Pointer itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::AddConstantToImageFilter< TInputImage, TConstant, TOutputImage >.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

void itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::operator= ( const Self & ) [private]

End concept checking

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Add2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >::typedef ( Concept::AdditiveOperators< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > )

Begin concept checking This class requires Input1Input2OutputAdditiveOperatorsCheck in the form of ( Concept::AdditiveOperators< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > )

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

itkAddImageFilter.h