ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference
Intensity Image Filters | MultiThreaded Filters | Module ITKImageIntensity

Perform a generic pixel-wise operation on N images. More...

#include <itkNaryFunctorImageFilter.h>

Inheritance diagram for itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >:
Collaboration diagram for itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef TFunction FunctorType
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef std::vector
< InputImagePixelType > 		NaryArrayType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< Self > Pointer
typedef NaryFunctorImageFilter Self
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 		Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
FunctorType & GetFunctor ()
virtual const char * GetNameOfClass () const
 typedef (Concept::HasZero< OutputImagePixelType >) OutputHasZeroCheck
 typedef (Concept::SameDimension< InputImageDimension, OutputImageDimension >) SameDimensionCheck
void SetFunctor (FunctorType &functor)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

 NaryFunctorImageFilter ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~NaryFunctorImageFilter ()

Private Member Functions

 NaryFunctorImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

FunctorType m_Functor

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction>
class itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >

Perform a generic pixel-wise operation on N images.

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

All the input images must be of the same type.

Definition at line 42 of file itkNaryFunctorImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TFunction>
typedef SmartPointer< const Self > itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::ConstPointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NaryAddImageFilter< TInputImage, TOutputImage >, and itk::NaryMaximumImageFilter< TInputImage, TOutputImage >.

Definition at line 51 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef TFunction itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType

Some typedefs.

Definition at line 57 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef InputImageType::PixelType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePixelType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 64 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef InputImageType::Pointer itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 62 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef InputImageType::RegionType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageRegionType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 63 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef TInputImage itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageType

Some convenient typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 61 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef std::vector< InputImagePixelType > itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::NaryArrayType

Definition at line 69 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef OutputImageType::PixelType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePixelType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 68 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef OutputImageType::Pointer itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 66 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef OutputImageType::RegionType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 67 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef TOutputImage itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageType

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 65 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef SmartPointer< Self > itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Pointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NaryAddImageFilter< TInputImage, TOutputImage >, and itk::NaryMaximumImageFilter< TInputImage, TOutputImage >.

Definition at line 50 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef NaryFunctorImageFilter itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NaryAddImageFilter< TInputImage, TOutputImage >, and itk::NaryMaximumImageFilter< TInputImage, TOutputImage >.

Definition at line 48 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef InPlaceImageFilter< TInputImage, TOutputImage > itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NaryAddImageFilter< TInputImage, TOutputImage >, and itk::NaryMaximumImageFilter< TInputImage, TOutputImage >.

Definition at line 49 of file itkNaryFunctorImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage, class TFunction>
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::NaryFunctorImageFilter ( ) [protected]

End concept checking

template<class TInputImage, class TOutputImage, class TFunction>
virtual itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::~NaryFunctorImageFilter ( ) [inline, protected, virtual]

Definition at line 111 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::NaryFunctorImageFilter ( const Self &  ) [private]

Member Function Documentation

template<class TInputImage, class TOutputImage, class TFunction>
virtual::itk::LightObject::Pointer itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::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::Object.

Reimplemented in itk::NaryAddImageFilter< TInputImage, TOutputImage >, and itk::NaryMaximumImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction>
FunctorType& itk::NaryFunctorImageFilter< TInputImage, 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 75 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
virtual const char* itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NaryAddImageFilter< TInputImage, TOutputImage >, and itk::NaryMaximumImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction>
static Pointer itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::NaryAddImageFilter< TInputImage, TOutputImage >, and itk::NaryMaximumImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction>
void itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::operator= ( const Self &  ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NaryAddImageFilter< TInputImage, TOutputImage >, and itk::NaryMaximumImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction>
void itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::SetFunctor ( 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 83 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
void itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

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

template<class TInputImage, class TOutputImage, class TFunction>
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::typedef ( Concept::HasZero< OutputImagePixelType >  )

This class requires OutputHasZeroCheck in the form of ( Concept::HasZero< OutputImagePixelType > )

template<class TInputImage, class TOutputImage, class TFunction>
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::typedef ( Concept::SameDimension< InputImageDimension, OutputImageDimension >  )

Begin concept checking This class requires SameDimensionCheck in the form of ( Concept::SameDimension< InputImageDimension, OutputImageDimension > )

Member Data Documentation

template<class TInputImage, class TOutputImage, class TFunction>
const unsigned int itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 95 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
FunctorType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::m_Functor [private]

Definition at line 130 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
const unsigned int itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constants

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 97 of file itkNaryFunctorImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 00:56:03 for ITK by doxygen 1.7.4