itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference
[Intensity Image Filters, Multithreaded Filters]

Implements pixel-wise generic operation on one image. More...

#include <itkUnaryFunctorImageFilter.h>

Inheritance diagram for itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >:

[legend]Collaboration diagram for itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >:

[legend]List of all members.

Public Types
typedef UnaryFunctorImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TFunction	FunctorType
typedef TInputImage	InputImageType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef TOutputImage	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
Public Member Functions
virtual const char *	GetClassName () const
FunctorType &	GetFunctor ()
const FunctorType &	GetFunctor () const
void	SetFunctor (const FunctorType &functor)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	UnaryFunctorImageFilter ()
virtual	~UnaryFunctorImageFilter ()
virtual void	GenerateOutputInformation ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

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

Implements pixel-wise generic operation on one image.

This class is parameterized over the type of the input image and the type of the output image. It is also parameterized by the operation to be applied, using a Functor style.

UnaryFunctorImageFilter allows the output dimension of the filter to be larger than the input dimension. Thus subclasses of the UnaryFunctorImageFilter (like the CastImageFilter) can be used to promote a 2D image to a 3D image, etc.

Definition at line 41 of file itkUnaryFunctorImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 48 of file itkUnaryFunctorImageFilter.h.

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

Some typedefs. Definition at line 57 of file itkUnaryFunctorImageFilter.h. Referenced by itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor().

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 61 of file itkUnaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction> typedef InputImageType::ConstPointer itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 59 of file itkUnaryFunctorImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 60 of file itkUnaryFunctorImageFilter.h.

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

Some convenient typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 58 of file itkUnaryFunctorImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 65 of file itkUnaryFunctorImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 63 of file itkUnaryFunctorImageFilter.h.

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

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 64 of file itkUnaryFunctorImageFilter.h.

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

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 62 of file itkUnaryFunctorImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 47 of file itkUnaryFunctorImageFilter.h.

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

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 45 of file itkUnaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction> typedef ImageToImageFilter<TInputImage,TOutputImage> itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 46 of file itkUnaryFunctorImageFilter.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 90 of file itkUnaryFunctorImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TOutputImage, class TFunction> virtual void itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GenerateOutputInformation (   )  [protected, virtual]

UnaryFunctorImageFilter can produce an image which is a different resolution than its input image. As such, UnaryFunctorImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below. See also: ProcessObject::GenerateOutputInformaton() Reimplemented from itk::ProcessObject.

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

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction> const FunctorType& itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor (   )  const [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 72 of file itkUnaryFunctorImageFilter.h. References itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType.

template<class TInputImage, class TOutputImage, class TFunction> FunctorType& itk::UnaryFunctorImageFilter< 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 71 of file itkUnaryFunctorImageFilter.h. References itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType.

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

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage, class TFunction> void itk::UnaryFunctorImageFilter< TInputImage, 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 81 of file itkUnaryFunctorImageFilter.h.

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

UnaryFunctorImageFilter 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:

• itkUnaryFunctorImageFilter.h

---