ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions
itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage > Class Template Reference
Intensity Image Filters | MultiThreaded Filters | Module ITKImageIntensity

Pixel-wise subtraction of two images. More...

#include <itkSubtractImageFilter.h>

Inheritance diagram for itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >:
Collaboration diagram for itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef SmartPointer< Self > Pointer
typedef SubtractImageFilter Self
typedef
BinaryFunctorImageFilter
< TInputImage1, TInputImage2,
TOutputImage, Functor::Sub2
< 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 ()
 SubtractImageFilter ()
virtual ~SubtractImageFilter ()
 SubtractImageFilter (const Self &)
void operator= (const Self &)

Detailed Description

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

Pixel-wise subtraction of two images.

Subtract each pixel from image2 from its corresponding pixel in image1:

 Output = Input1 - Input2.

This is done using

 SetInput1( image1 );
 SetInput2( image2 );

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.

Additionally, a constant can be subtracted from every pixel in an image using:

 SetInput1( image1 );
 SetConstant2( constant );
Note:
The result of AddImageFilter with a negative constant is not necessarily the same as SubtractImageFilter. This would be the case when the PixelType defines an operator-() that is not the inverse of operator+()
Wiki Examples:

Definition at line 94 of file itkSubtractImageFilter.h.

Member Typedef Documentation

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
typedef SmartPointer< const Self > itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstPointer

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

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

Definition at line 112 of file itkSubtractImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
typedef SmartPointer< Self > itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >::Pointer

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

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

Definition at line 111 of file itkSubtractImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
typedef SubtractImageFilter itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >::Self

Standard class typedefs.

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

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

Definition at line 104 of file itkSubtractImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
typedef BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Sub2< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > > itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >::Superclass

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

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

Definition at line 109 of file itkSubtractImageFilter.h.

Constructor & Destructor Documentation

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

End concept checking

Definition at line 131 of file itkSubtractImageFilter.h.

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

End concept checking

Definition at line 132 of file itkSubtractImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >::SubtractImageFilter ( const Self &  ) [private]

End concept checking

Member Function Documentation

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
virtual::itk::LightObject::Pointer itk::SubtractImageFilter< 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::Sub2< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

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

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
virtual const char* itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

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

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

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

Method for creation through the object factory.

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

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

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

End concept checking

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

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
itk::SubtractImageFilter< 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:
Generated on Mon Dec 19 2011 01:29:25 for ITK by doxygen 1.7.4