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

ITK 4.1.0

Insight Segmentation and Registration Toolkit

#include <itkWeightedAddImageFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FunctorType	FunctorType
typedef SmartPointer< Self >	Pointer
typedef FunctorType::RealType	RealType
typedef WeightedAddImageFilter	Self
typedef BinaryFunctorImageFilter < TInputImage1, TInputImage2, TOutputImage, Functor::WeightedAdd2 < 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::HasNumericTraits< typename TInputImage1::PixelType >) Input1HasNumericTraitsCheck
	typedef (Concept::MultiplyOperator< typename TInputImage1::PixelType, RealType, RealType >) Input1RealTypeMultiplyCheck
	typedef (Concept::MultiplyOperator< typename TInputImage2::PixelType, RealType, RealType >) Input2RealTypeMultiplyCheck

void	SetAlpha (RealType alpha)
Static Public Member Functions
static Pointer	New ()
	WeightedAddImageFilter ()
virtual	~WeightedAddImageFilter ()
	WeightedAddImageFilter (const Self &)
void	operator= (const Self &)

Detailed Description

template<class TInputImage1, class TInputImage2, class TOutputImage>
class itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >

Computes a weighted sum of two images pixel-wise.

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 * alpha +  pixel_from_image_2 * (1.0 - alpha)

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 * alpha + input2_pixel * (1-alpha) )

The alpha parameter is set using SetAlpha.

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

Definition at line 114 of file itkWeightedAddImageFilter.h.

Member Typedef Documentation

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

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

Definition at line 134 of file itkWeightedAddImageFilter.h.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

typedef Superclass::FunctorType itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::FunctorType

Some convenient typedefs.

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

Definition at line 136 of file itkWeightedAddImageFilter.h.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

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

Definition at line 133 of file itkWeightedAddImageFilter.h.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

typedef FunctorType::RealType itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::RealType

Definition at line 137 of file itkWeightedAddImageFilter.h.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

Standard class typedefs.

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

Definition at line 125 of file itkWeightedAddImageFilter.h.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

typedef BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::WeightedAdd2< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > > itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::Superclass

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

Definition at line 131 of file itkWeightedAddImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

End concept checking

Definition at line 168 of file itkWeightedAddImageFilter.h.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

End concept checking

Definition at line 169 of file itkWeightedAddImageFilter.h.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

End concept checking

Member Function Documentation

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

virtual::itk::LightObject::Pointer itk::WeightedAddImageFilter< 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::WeightedAdd2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

Runtime information support.

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

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

Method for creation through the object factory.

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

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

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

End concept checking

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

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

void itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetAlpha ( RealType alpha ) [inline]

Set the weight for the first operand of the weighted addition

Definition at line 147 of file itkWeightedAddImageFilter.h.

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::typedef ( Concept::HasNumericTraits< typename TInputImage1::PixelType > )

Begin concept checking This class requires Input1HasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< typename TInputImage1::PixelType > )

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::typedef ( Concept::MultiplyOperator< typename TInputImage1::PixelType, RealType, RealType > )

This class requires Input1RealTypeMultiplyCheck in the form of ( Concept::MultiplyOperator< typename TInputImage1::PixelType, RealType, RealType > )

template<class TInputImage1 , class TInputImage2 , class TOutputImage >

itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::typedef ( Concept::MultiplyOperator< typename TInputImage2::PixelType, RealType, RealType > )

This class requires Input2RealTypeMultiplyCheck in the form of ( Concept::MultiplyOperator< typename TInputImage2::PixelType, RealType, RealType > )

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

itkWeightedAddImageFilter.h