otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference

#include <otbUnaryFunctorNeighborhoodImageFilter.h>

Inheritance diagram for otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >:

Collaboration diagram for otb::UnaryFunctorNeighborhoodImageFilter< 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 InputImageType::SizeType	InputImageSizeType
typedef Superclass::InputImageType	InputImageType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef Superclass::OutputImageType	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef itk::ProcessObject	ProcessObjectType
typedef UnaryFunctorNeighborhoodImageFilter	Self
typedef itk::ImageToImageFilter< TInputImage, TOutputImage >	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

Static Public Member Functions
static Pointer	New ()
typedef itk::ConstNeighborhoodIterator< TInputImage >	NeighborhoodIteratorType
typedef NeighborhoodIteratorType::RadiusType	RadiusType
typedef unsigned char	RadiusSizeType
InputImageSizeType	m_Radius
FunctorType	m_Functor
virtual void	SetRadius (InputImageSizeType _arg)
virtual InputImageSizeType	GetRadius ()
void	SetRadius (unsigned int radius)
FunctorType &	GetFunctor ()
const FunctorType &	GetFunctor () const
void	SetFunctor (const FunctorType &functor)
	UnaryFunctorNeighborhoodImageFilter ()
	~UnaryFunctorNeighborhoodImageFilter () override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
void	GenerateInputRequestedRegion (void) override
	UnaryFunctorNeighborhoodImageFilter (const Self &)=delete
void	operator= (const Self &)=delete

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction>
class otb::UnaryFunctorNeighborhoodImageFilter< 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 43 of file otbUnaryFunctorNeighborhoodImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage , class TFunction >

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

Definition at line 50 of file otbUnaryFunctorNeighborhoodImageFilter.h.

FunctorType

template<class TInputImage , class TOutputImage , class TFunction >

typedef TFunction otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType

Some convenient typedefs.

Definition at line 56 of file otbUnaryFunctorNeighborhoodImageFilter.h.

InputImagePixelType

template<class TInputImage , class TOutputImage , class TFunction >

typedef InputImageType::PixelType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePixelType

Definition at line 63 of file otbUnaryFunctorNeighborhoodImageFilter.h.

InputImagePointer

template<class TInputImage , class TOutputImage , class TFunction >

typedef InputImageType::ConstPointer otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer

Definition at line 61 of file otbUnaryFunctorNeighborhoodImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage , class TFunction >

typedef InputImageType::RegionType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::InputImageRegionType

Definition at line 62 of file otbUnaryFunctorNeighborhoodImageFilter.h.

InputImageSizeType

template<class TInputImage , class TOutputImage , class TFunction >

typedef InputImageType::SizeType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::InputImageSizeType

Definition at line 64 of file otbUnaryFunctorNeighborhoodImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage , class TFunction >

typedef Superclass::InputImageType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::InputImageType

Definition at line 60 of file otbUnaryFunctorNeighborhoodImageFilter.h.

NeighborhoodIteratorType

template<class TInputImage , class TOutputImage , class TFunction >

typedef itk::ConstNeighborhoodIterator<TInputImage> otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::NeighborhoodIteratorType

Set/Get the radius of neighborhood.

Definition at line 116 of file otbUnaryFunctorNeighborhoodImageFilter.h.

OutputImagePixelType

template<class TInputImage , class TOutputImage , class TFunction >

typedef OutputImageType::PixelType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePixelType

Definition at line 68 of file otbUnaryFunctorNeighborhoodImageFilter.h.

OutputImagePointer

template<class TInputImage , class TOutputImage , class TFunction >

typedef OutputImageType::Pointer otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePointer

Definition at line 66 of file otbUnaryFunctorNeighborhoodImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage , class TFunction >

typedef OutputImageType::RegionType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageRegionType

Definition at line 67 of file otbUnaryFunctorNeighborhoodImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage , class TFunction >

typedef Superclass::OutputImageType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageType

Definition at line 65 of file otbUnaryFunctorNeighborhoodImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage , class TFunction >

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

Definition at line 49 of file otbUnaryFunctorNeighborhoodImageFilter.h.

ProcessObjectType

template<class TInputImage , class TOutputImage , class TFunction >

typedef itk::ProcessObject otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::ProcessObjectType

Definition at line 70 of file otbUnaryFunctorNeighborhoodImageFilter.h.

RadiusSizeType

template<class TInputImage , class TOutputImage , class TFunction >

typedef unsigned char otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::RadiusSizeType

Set/Get the radius of neighborhood.

Definition at line 118 of file otbUnaryFunctorNeighborhoodImageFilter.h.

RadiusType

template<class TInputImage , class TOutputImage , class TFunction >

typedef NeighborhoodIteratorType::RadiusType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::RadiusType

Set/Get the radius of neighborhood.

Definition at line 117 of file otbUnaryFunctorNeighborhoodImageFilter.h.

Self

template<class TInputImage , class TOutputImage , class TFunction >

typedef UnaryFunctorNeighborhoodImageFilter otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 47 of file otbUnaryFunctorNeighborhoodImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage , class TFunction >

typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Definition at line 48 of file otbUnaryFunctorNeighborhoodImageFilter.h.

Constructor & Destructor Documentation

UnaryFunctorNeighborhoodImageFilter() [1/2]

template<class TInputImage , class TOutputImage , class TFunction >

otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::UnaryFunctorNeighborhoodImageFilter

protected

Constructor

Definition at line 37 of file otbUnaryFunctorNeighborhoodImageFilter.hxx.

~UnaryFunctorNeighborhoodImageFilter()

template<class TInputImage , class TOutputImage , class TFunction >

otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::~UnaryFunctorNeighborhoodImageFilter ( )

inlineoverrideprotected

Destructor

Definition at line 129 of file otbUnaryFunctorNeighborhoodImageFilter.h.

UnaryFunctorNeighborhoodImageFilter() [2/2]

template<class TInputImage , class TOutputImage , class TFunction >

otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::UnaryFunctorNeighborhoodImageFilter ( const Self &  )

privatedelete

Set/Get the radius of neighborhood.

Member Function Documentation

CreateAnother()

template<class TInputImage , class TOutputImage , class TFunction >

virtual::itk::LightObject::Pointer otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::CreateAnother

(

void

)

const

GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage , class TFunction >

void otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::GenerateInputRequestedRegion ( void  )

overrideprotected

Pad the input requested region by radius

Definition at line 43 of file otbUnaryFunctorNeighborhoodImageFilter.hxx.

GetFunctor() [1/2]

template<class TInputImage , class TOutputImage , class TFunction >

FunctorType& otb::UnaryFunctorNeighborhoodImageFilter< 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 87 of file otbUnaryFunctorNeighborhoodImageFilter.h.

GetFunctor() [2/2]

template<class TInputImage , class TOutputImage , class TFunction >

const FunctorType& otb::UnaryFunctorNeighborhoodImageFilter< 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 98 of file otbUnaryFunctorNeighborhoodImageFilter.h.

GetNameOfClass()

template<class TInputImage , class TOutputImage , class TFunction >

virtual const char* otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetRadius()

template<class TInputImage , class TOutputImage , class TFunction >

virtual InputImageSizeType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::GetRadius ( )

virtual

Set/Get the radius of neighborhood.

New()

template<class TInputImage , class TOutputImage , class TFunction >

static Pointer otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TInputImage , class TOutputImage , class TFunction >

void otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::operator= ( const Self &  )

privatedelete

Set/Get the radius of neighborhood.

SetFunctor()

template<class TInputImage , class TOutputImage , class TFunction >

void otb::UnaryFunctorNeighborhoodImageFilter< 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 109 of file otbUnaryFunctorNeighborhoodImageFilter.h.

SetRadius() [1/2]

template<class TInputImage , class TOutputImage , class TFunction >

virtual void otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::SetRadius ( InputImageSizeType  _arg )

virtual

Set/Get the radius of neighborhood.

SetRadius() [2/2]

template<class TInputImage , class TOutputImage , class TFunction >

void otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::SetRadius ( unsigned int  radius )

inline

Set unsigned int radius

Definition at line 78 of file otbUnaryFunctorNeighborhoodImageFilter.h.

ThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TFunction >

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

overrideprotected

UnaryFunctorNeighborhoodImageFilter 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 94 of file otbUnaryFunctorNeighborhoodImageFilter.hxx.

Member Data Documentation

m_Functor

template<class TInputImage , class TOutputImage , class TFunction >

FunctorType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::m_Functor

private

Set/Get the radius of neighborhood.

Definition at line 155 of file otbUnaryFunctorNeighborhoodImageFilter.h.

m_Radius

template<class TInputImage , class TOutputImage , class TFunction >

InputImageSizeType otb::UnaryFunctorNeighborhoodImageFilter< TInputImage, TOutputImage, TFunction >::m_Radius

private

Set/Get the radius of neighborhood.

Definition at line 154 of file otbUnaryFunctorNeighborhoodImageFilter.h.

---

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

• otbUnaryFunctorNeighborhoodImageFilter.h
• otbUnaryFunctorNeighborhoodImageFilter.hxx