Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference

Implements neighborhood-wise generic operation on image. More...

#include <otbUnaryFunctorWithIndexImageFilter.h>

+ Inheritance diagram for otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >:
+ Collaboration diagram for otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TFunction FunctorType
 
typedef InputImageType::IndexType InputImageIndexType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef Superclass::InputImageType InputImageType
 
typedef
itk::ImageRegionConstIteratorWithIndex
< TInputImage > 
IteratorType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef
UnaryFunctorWithIndexImageFilter 
Self
 
typedef
itk::ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
virtual const char * GetNameOfClass () const
 
void SetFunctor (const FunctorType &functor)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Protected Member Functions

 UnaryFunctorWithIndexImageFilter ()
 
virtual ~UnaryFunctorWithIndexImageFilter ()
 
virtual void GenerateInputRequestedRegion (void)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 

Private Member Functions

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

Private Attributes

FunctorType m_Functor
 

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction>
class otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >

Implements neighborhood-wise generic operation on image.

This class is parameterized over the input image type 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 otbUnaryFunctorWithIndexImageFilter.h.

Member Typedef Documentation

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

Definition at line 45 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef TFunction otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType

Some convenient typedefs.

Definition at line 51 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::IndexType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::InputImageIndexType

Definition at line 60 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::PixelType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePixelType

Definition at line 58 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::ConstPointer otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer

Definition at line 56 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::RegionType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::InputImageRegionType

Definition at line 57 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::SizeType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::InputImageSizeType

Definition at line 59 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef Superclass::InputImageType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::InputImageType

Definition at line 55 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef itk::ImageRegionConstIteratorWithIndex<TInputImage> otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::IteratorType

Definition at line 99 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef OutputImageType::PixelType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePixelType

Definition at line 64 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef OutputImageType::Pointer otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePointer

Definition at line 62 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef OutputImageType::RegionType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageRegionType

Definition at line 63 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef Superclass::OutputImageType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageType

Definition at line 61 of file otbUnaryFunctorWithIndexImageFilter.h.

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

Definition at line 44 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef itk::ProcessObject otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::ProcessObjectType

Definition at line 66 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
typedef UnaryFunctorWithIndexImageFilter otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 42 of file otbUnaryFunctorWithIndexImageFilter.h.

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

Definition at line 43 of file otbUnaryFunctorWithIndexImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage , class TFunction >
otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::UnaryFunctorWithIndexImageFilter ( )
protected

Constructor

Definition at line 32 of file otbUnaryFunctorWithIndexImageFilter.txx.

template<class TInputImage , class TOutputImage , class TFunction >
virtual otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::~UnaryFunctorWithIndexImageFilter ( )
inlineprotectedvirtual

Destructor

Definition at line 109 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::UnaryFunctorWithIndexImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputImage , class TFunction >
virtual::itk::LightObject::Pointer otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::CreateAnother ( void  ) const
template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::GenerateInputRequestedRegion ( void  )
protectedvirtual
template<class TInputImage , class TOutputImage , class TFunction >
FunctorType& otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor ( void  )
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 otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
const FunctorType& otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor ( void  ) 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 82 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
virtual const char* otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage , class TFunction >
static Pointer otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::operator= ( const Self )
private
template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorWithIndexImageFilter< 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 93 of file otbUnaryFunctorWithIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protectedvirtual

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

ThreadedGenerateData Performs the neighborhood-wise operation

Definition at line 90 of file otbUnaryFunctorWithIndexImageFilter.txx.

References itk::ImageConstIteratorWithIndex< TImage >::Get(), itk::ImageConstIteratorWithIndex< TImage >::GetIndex(), itk::ImageRegionConstIterator< TImage >::GoToBegin(), itk::ImageConstIteratorWithIndex< TImage >::GoToBegin(), itk::ImageConstIteratorWithIndex< TImage >::IsAtEnd(), and itk::ImageRegionIterator< TImage >::Set().

Member Data Documentation

template<class TInputImage , class TOutputImage , class TFunction >
FunctorType otb::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunction >::m_Functor
private

Definition at line 132 of file otbUnaryFunctorWithIndexImageFilter.h.


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