itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage > Class Template Reference
[Intensity Image Filters, Multithreaded Filters]

Implements an operator for computed a weighted sum of two images pixel-wise. More...

#include <itkWeightedAddImageFilter.h>

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

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

[legend]List of all members.

Public Types
typedef WeightedAddImageFilter	Self
typedef BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::WeightedAdd2< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FunctorType	FunctorType
typedef FunctorType::RealType	RealType
Public Member Functions
void	SetAlpha (RealType alpha)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	WeightedAddImageFilter ()
virtual	~WeightedAddImageFilter ()

---

Detailed Description

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

Implements an operator for computed a weighted sum of two images pixel-wise.

This class is parametrized 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) )

Warning:

No numeric overflow checking is performed in this filter.

Definition at line 81 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, TFunction >. Definition at line 101 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, TFunction >. Definition at line 103 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, TFunction >. Definition at line 100 of file itkWeightedAddImageFilter.h.

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

Definition at line 104 of file itkWeightedAddImageFilter.h. Referenced by itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetAlpha().

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, TFunction >. Definition at line 93 of file itkWeightedAddImageFilter.h. Referenced by itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::~WeightedAddImageFilter().

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, TFunction >. Definition at line 99 of file itkWeightedAddImageFilter.h.

---

Constructor & Destructor Documentation

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

Definition at line 118 of file itkWeightedAddImageFilter.h.

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

Definition at line 119 of file itkWeightedAddImageFilter.h. References itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::Self.

---

Member Function Documentation

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

Method for creation through the object factory. Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >.

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

Set the weigth for the first operand of the weighted addition Definition at line 110 of file itkWeightedAddImageFilter.h. References itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::RealType.

---

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

• itkWeightedAddImageFilter.h

---