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

Implements neighborhood-wise generic operation of one vector image. More...

#include <otbUnaryFunctorVectorImageFilter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TFunction FunctorType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef
UnaryFunctorVectorImageFilter 
Self
 
typedef
itk::InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
FunctorTypeGetFunctor ()
 
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)
 

Static Public Attributes

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

Protected Member Functions

 UnaryFunctorVectorImageFilter ()
 
virtual ~UnaryFunctorVectorImageFilter ()
 
virtual void GenerateOutputInformation (void)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 

Private Member Functions

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

Private Attributes

FunctorType m_Functor
 

Detailed Description

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

Implements neighborhood-wise generic operation of one vector image.

This class is parameterized over the types of the input image 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 35 of file otbUnaryFunctorVectorImageFilter.h.

Member Typedef Documentation

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

Definition at line 43 of file otbUnaryFunctorVectorImageFilter.h.

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

Some convenient typedefs.

Definition at line 56 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 60 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 58 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 59 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 57 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 64 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 62 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 63 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 61 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 42 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 66 of file otbUnaryFunctorVectorImageFilter.h.

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

Standard class typedefs.

Definition at line 40 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 41 of file otbUnaryFunctorVectorImageFilter.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 34 of file otbUnaryFunctorVectorImageFilter.txx.

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

Definition at line 91 of file otbUnaryFunctorVectorImageFilter.h.

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

Member Function Documentation

template<class TInputImage, class TOutputImage, class TFunction>
virtual::itk::LightObject::Pointer otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, TFunction >::CreateAnother ( void  ) const
template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, TFunction >::GenerateOutputInformation ( void  )
protectedvirtual

Since the number of components per pixel depends on the radius range, one must reimplement this method to set the proper number of component on the filter output.

Generate the output information

Definition at line 46 of file otbUnaryFunctorVectorImageFilter.txx.

template<class TInputImage, class TOutputImage, class TFunction>
FunctorType& otb::UnaryFunctorVectorImageFilter< 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 otbUnaryFunctorVectorImageFilter.h.

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

Run-time type information (and related methods).

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

Reimplemented in otb::NormalizeVectorImageFilter< TInputImage, TOutputImage >.

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

Method for creation through the object factory.

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

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

UnaryFunctorVectorImageFilter 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 60 of file otbUnaryFunctorVectorImageFilter.txx.

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

Member Data Documentation

template<class TInputImage, class TOutputImage, class TFunction>
const unsigned int otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageDimension = TInputImage::ImageDimension
static

Dimension

Definition at line 52 of file otbUnaryFunctorVectorImageFilter.h.

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

Definition at line 116 of file otbUnaryFunctorVectorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
const unsigned int otb::UnaryFunctorVectorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageDimension = TOutputImage::ImageDimension
static

Definition at line 53 of file otbUnaryFunctorVectorImageFilter.h.


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