itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference

Perform a generic pixel-wise index specific operation on an input image and produces an output image. More...

#include <itkIndexedUnaryFunctorImageFilter.h>

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

Collaboration diagram for itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >:

Public Types
typedef IndexedUnaryFunctorImageFilter	Self
typedef InPlaceImageFilter< 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
static Pointer	New ()

Protected Member Functions
	IndexedUnaryFunctorImageFilter ()
virtual	~IndexedUnaryFunctorImageFilter ()
virtual void	GenerateOutputInformation ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TFunction>
class itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >

Perform a generic pixel-wise index specific operation on an input image and produces an output image.

This is filter is simelar to itk::UnaryFunctorImageFilter, but it can used for operations where the index position in the input image is relevant for the output result.
Class is templated over the type of the input image 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.

Definition at line 39 of file itkIndexedUnaryFunctorImageFilter.h.

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef SmartPointer< const Self > itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::ConstPointer

Definition at line 46 of file itkIndexedUnaryFunctorImageFilter.h.

FunctorType

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef TFunction itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType

Some typedefs.

Definition at line 52 of file itkIndexedUnaryFunctorImageFilter.h.

InputImagePixelType

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef InputImageType::PixelType itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePixelType

Definition at line 60 of file itkIndexedUnaryFunctorImageFilter.h.

InputImagePointer

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef InputImageType::ConstPointer itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer

Definition at line 58 of file itkIndexedUnaryFunctorImageFilter.h.

InputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef InputImageType::RegionType itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageRegionType

Definition at line 59 of file itkIndexedUnaryFunctorImageFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef TInputImage itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageType

Definition at line 57 of file itkIndexedUnaryFunctorImageFilter.h.

OutputImagePixelType

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef OutputImageType::PixelType itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePixelType

Definition at line 65 of file itkIndexedUnaryFunctorImageFilter.h.

OutputImagePointer

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef OutputImageType::Pointer itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePointer

Definition at line 63 of file itkIndexedUnaryFunctorImageFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef OutputImageType::RegionType itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageRegionType

Definition at line 64 of file itkIndexedUnaryFunctorImageFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef TOutputImage itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageType

Definition at line 62 of file itkIndexedUnaryFunctorImageFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef SmartPointer< Self > itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Pointer

Definition at line 45 of file itkIndexedUnaryFunctorImageFilter.h.

Self

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef IndexedUnaryFunctorImageFilter itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 43 of file itkIndexedUnaryFunctorImageFilter.h.

Superclass

template<typename TInputImage , typename TOutputImage , typename TFunction >

typedef InPlaceImageFilter< TInputImage, TOutputImage > itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Definition at line 44 of file itkIndexedUnaryFunctorImageFilter.h.

Constructor & Destructor Documentation

IndexedUnaryFunctorImageFilter()

template<typename TInputImage , typename TOutputImage , typename TFunction >

itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::IndexedUnaryFunctorImageFilter ( )

protected

~IndexedUnaryFunctorImageFilter()

template<typename TInputImage , typename TOutputImage , typename TFunction >

virtual itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::~IndexedUnaryFunctorImageFilter ( )

inlineprotectedvirtual

Definition at line 91 of file itkIndexedUnaryFunctorImageFilter.h.

Member Function Documentation

GenerateOutputInformation()

template<typename TInputImage , typename TOutputImage , typename TFunction >

virtual void itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GenerateOutputInformation ( )

protectedvirtual

IndexedUnaryFunctorImageFilter can produce an image which is a different resolution than its input image. As such, IndexedUnaryFunctorImageFilter 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()

GetClassName()

template<typename TInputImage , typename TOutputImage , typename TFunction >

virtual const char* itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

GetFunctor() [1/2]

template<typename TInputImage , typename TOutputImage , typename TFunction >

FunctorType& itk::IndexedUnaryFunctorImageFilter< 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 itkIndexedUnaryFunctorImageFilter.h.

GetFunctor() [2/2]

template<typename TInputImage , typename TOutputImage , typename TFunction >

const FunctorType& itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor ( ) const

inline

Definition at line 72 of file itkIndexedUnaryFunctorImageFilter.h.

New()

template<typename TInputImage , typename TOutputImage , typename TFunction >

static Pointer itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::New ( )

static

Method for creation through the object factory.

SetFunctor()

template<typename TInputImage , typename TOutputImage , typename TFunction >

void itk::IndexedUnaryFunctorImageFilter< 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 80 of file itkIndexedUnaryFunctorImageFilter.h.

ThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TFunction >

void itk::IndexedUnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, ThreadIdType  threadId  )

protected

IndexedUnaryFunctorImageFilter 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()

---

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

• itkIndexedUnaryFunctorImageFilter.h