Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

Implements pixel-wise generic operation of two images. More...

#include <itkBinaryFunctorImageFilter.h>

Inheritance diagram for itk::BinaryFunctorImageFilter:

Inheritance graph
[legend]
Collaboration diagram for itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef BinaryFunctorImageFilter Self
typedef ImageToImageFilter<
TInputImage1, TOutputImage > 		Superclass
typedef SmartPointer< Self > Pointer
typedef SmartPointer< const
Self > 		ConstPointer
typedef TFunction FunctorType
typedef TInputImage1 Input1ImageType
typedef Input1ImageType::ConstPointer Input1ImagePointer
typedef Input1ImageType::RegionType Input1ImageRegionType
typedef Input1ImageType::PixelType Input1ImagePixelType
typedef TInputImage2 Input2ImageType
typedef Input2ImageType::ConstPointer Input2ImagePointer
typedef Input2ImageType::RegionType Input2ImageRegionType
typedef Input2ImageType::PixelType Input2ImagePixelType
typedef TOutputImage OutputImageType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef OutputImageType::PixelType OutputImagePixelType

Public Methods

virtual const char * GetClassName () const
void SetInput1 (const TInputImage1 *image1)
void SetInput2 (const TInputImage2 *image2)
FunctorType & GetFunctor ()
void SetFunctor (const FunctorType &functor)

Static Public Methods

Pointer New ()

Protected Methods

 BinaryFunctorImageFilter ()
virtual ~BinaryFunctorImageFilter ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

Detailed Description

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
class itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >

Implements pixel-wise generic operation of two images.

This class is parameterized over the types of the two input images and the type of the output image. It is also parameterized by the operation to be applied. A Functor style is used.

Definition at line 37 of file itkBinaryFunctorImageFilter.h.

Member Typedef Documentation

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef SmartPointer<const Self> itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::ConstPointer
 

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::JoinImageFilter< TInputImage1, TInputImage2 >, itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >, and itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >.

Definition at line 45 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef TFunction itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::FunctorType
 

Some convenient typedefs.

Reimplemented in itk::JoinImageFilter< TInputImage1, TInputImage2 >.

Definition at line 54 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input1ImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImagePixelType
 

Definition at line 58 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input1ImageType::ConstPointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImagePointer
 

Definition at line 56 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input1ImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImageRegionType
 

Definition at line 57 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef TInputImage1 itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImageType
 

Definition at line 55 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input2ImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImagePixelType
 

Definition at line 62 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input2ImageType::ConstPointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImagePointer
 

Definition at line 60 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input2ImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImageRegionType
 

Definition at line 61 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef TInputImage2 itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImageType
 

Definition at line 59 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef OutputImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImagePixelType
 

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::JoinImageFilter< TInputImage1, TInputImage2 >.

Definition at line 66 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef OutputImageType::Pointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImagePointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 64 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef OutputImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImageRegionType
 

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Definition at line 65 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef TOutputImage itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImageType
 

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::JoinImageFilter< TInputImage1, TInputImage2 >.

Definition at line 63 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef SmartPointer<Self> itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Pointer
 

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::JoinImageFilter< TInputImage1, TInputImage2 >, itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >, and itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >.

Definition at line 44 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef BinaryFunctorImageFilter itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Self
 

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::JoinImageFilter< TInputImage1, TInputImage2 >, itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >, and itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >.

Definition at line 42 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef ImageToImageFilter<TInputImage1,TOutputImage> itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Superclass
 

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::JoinImageFilter< TInputImage1, TInputImage2 >, itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >, and itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >.

Definition at line 43 of file itkBinaryFunctorImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::BinaryFunctorImageFilter (    )  [protected]
 

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

Definition at line 95 of file itkBinaryFunctorImageFilter.h.

Member Function Documentation

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
virtual const char* itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GetClassName (    )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::JoinImageFilter< TInputImage1, TInputImage2 >.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
FunctorType& itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GetFunctor (    )  [inline]
 

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 78 of file itkBinaryFunctorImageFilter.h.

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

Method for creation through the object factory.

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::JoinImageFilter< TInputImage1, TInputImage2 >, itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >, and itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetFunctor (  const FunctorType &    functor )  [inline]
 

Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator!=() be defined on the functor (or the compiler's default implementation of operator!=() being appropriate).

Definition at line 86 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetInput1 (  const TInputImage1 *    image1 ) 
 

Connect one of the operands for pixel-wise addition

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetInput2 (  const TInputImage2 *    image2 ) 
 

Connect one of the operands for pixel-wise addition

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::ThreadedGenerateData (  const OutputImageRegionType &    outputRegionForThread,
int    threadId
)  [protected, virtual]
 

BinaryFunctorImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

The documentation for this class was generated from the following file:
Generated at Wed Mar 12 01:14:03 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000