otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction > Class Template Reference

#include <otbUnaryFunctorObjectListFilter.h>

Inheritance diagram for otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >:

Collaboration diagram for otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef TFunction	FunctorType
typedef TInputList::ConstIterator	InputListIterator
typedef TInputList::ConstPointer	InputListPointer
typedef TInputList	InputListType
typedef TOutputList::ConstIterator	OutputListIterator
typedef TOutputList::Pointer	OutputListPointer
typedef TOutputList	OutputListType
typedef itk::SmartPointer< Self >	Pointer
typedef UnaryFunctorObjectListFilter	Self
typedef otb::ObjectListToObjectListFilter< TInputList, TOutputList >	Superclass
Public Types inherited from otb::ObjectListToObjectListFilter< TInputList, TOutputList >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::DataObject::Pointer	DataObjectPointer
typedef TInputList::ConstIterator	InputListIterator
typedef TInputList::ConstPointer	InputListPointer
typedef TInputList	InputListType
typedef InputListType::ObjectType	InputObjectType
typedef TOutputList::Pointer	OutputListPointer
typedef TOutputList	OutputListType
typedef OutputListType::ObjectType	OutputObjectType
typedef itk::SmartPointer< Self >	Pointer
typedef ObjectListToObjectListFilter	Self
typedef otb::ObjectListSource< TOutputList >	Superclass
Public Types inherited from otb::ObjectListSource< TOutputList >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::DataObject::Pointer	DataObjectPointer
typedef itk::ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef TOutputList::Pointer	OutputListPointer
typedef TOutputList	OutputListType
typedef itk::SmartPointer< Self >	Pointer
typedef ObjectListSource	Self
typedef itk::ProcessObject	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
FunctorType &	GetFunctor ()
const FunctorType &	GetFunctor () const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from otb::ObjectListToObjectListFilter< TInputList, TOutputList >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const InputListType *	GetInput (void)
virtual void	SetInput (const InputListType *input)
Public Member Functions inherited from otb::ObjectListSource< TOutputList >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override
void	GraftOutput (itk::DataObject *graft)
void	GraftNthOutput (DataObjectPointerArraySizeType idx, itk::DataObject *graft)
OutputListType *	GetOutput (void)
OutputListType *	GetOutput (DataObjectPointerArraySizeType idx)

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from otb::ObjectListToObjectListFilter< TInputList, TOutputList >
static Pointer	New ()
Static Public Member Functions inherited from otb::ObjectListSource< TOutputList >
static Pointer	New ()
FunctorType	m_Functor
void	SetFunctor (const FunctorType &functor)
	UnaryFunctorObjectListFilter ()
	~UnaryFunctorObjectListFilter () override
void	AfterThreadedGenerateData () override
void	ThreadedGenerateData (unsigned int startIndex, unsigned int stopIndex, itk::ThreadIdType threadId) override
	UnaryFunctorObjectListFilter (const Self &)=delete
void	operator= (const Self &)=delete

Additional Inherited Members
Protected Types inherited from otb::ObjectListToObjectListFilter< TInputList, TOutputList >
typedef std::vector< OutputListPointer >	OutputListForThreadType
Protected Member Functions inherited from otb::ObjectListToObjectListFilter< TInputList, TOutputList >
virtual void	BeforeThreadedGenerateData ()
void	GenerateData (void) override
	ObjectListToObjectListFilter ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
virtual int	SplitRequestedRegion (itk::ThreadIdType threadId, int threadCount, unsigned int requestedElements, unsigned int &startIndex, unsigned int &stopIndex)
	~ObjectListToObjectListFilter () override
Protected Member Functions inherited from otb::ObjectListSource< TOutputList >
	ObjectListSource ()
	~ObjectListSource () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
virtual void	AllocateOutputs ()
void	GenerateData (void) override
Static Protected Member Functions inherited from otb::ObjectListToObjectListFilter< TInputList, TOutputList >
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes inherited from otb::ObjectListToObjectListFilter< TInputList, TOutputList >
OutputListForThreadType	m_ObjectListPerThread

Detailed Description

template<class TInputList, class TOutputList, class TFunction>
class otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >

Process each element in the ObjectList with the functor.

Each element of the ObjectList is processed by the functor. This is similar to the python map() function.

Definition at line 41 of file otbUnaryFunctorObjectListFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputList , class TOutputList , class TFunction >

typedef itk::SmartPointer<const Self> otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::ConstPointer

Definition at line 48 of file otbUnaryFunctorObjectListFilter.h.

FunctorType

template<class TInputList , class TOutputList , class TFunction >

typedef TFunction otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::FunctorType

Some typedefs.

Definition at line 54 of file otbUnaryFunctorObjectListFilter.h.

InputListIterator

template<class TInputList , class TOutputList , class TFunction >

typedef TInputList::ConstIterator otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::InputListIterator

Definition at line 62 of file otbUnaryFunctorObjectListFilter.h.

InputListPointer

template<class TInputList , class TOutputList , class TFunction >

typedef TInputList::ConstPointer otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::InputListPointer

Definition at line 60 of file otbUnaryFunctorObjectListFilter.h.

InputListType

template<class TInputList , class TOutputList , class TFunction >

typedef TInputList otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::InputListType

Definition at line 58 of file otbUnaryFunctorObjectListFilter.h.

OutputListIterator

template<class TInputList , class TOutputList , class TFunction >

typedef TOutputList::ConstIterator otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::OutputListIterator

Definition at line 63 of file otbUnaryFunctorObjectListFilter.h.

OutputListPointer

template<class TInputList , class TOutputList , class TFunction >

typedef TOutputList::Pointer otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::OutputListPointer

Definition at line 61 of file otbUnaryFunctorObjectListFilter.h.

OutputListType

template<class TInputList , class TOutputList , class TFunction >

typedef TOutputList otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::OutputListType

Definition at line 59 of file otbUnaryFunctorObjectListFilter.h.

Pointer

template<class TInputList , class TOutputList , class TFunction >

typedef itk::SmartPointer<Self> otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::Pointer

Definition at line 47 of file otbUnaryFunctorObjectListFilter.h.

Self

template<class TInputList , class TOutputList , class TFunction >

typedef UnaryFunctorObjectListFilter otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::Self

Standard class typedefs.

Definition at line 45 of file otbUnaryFunctorObjectListFilter.h.

Superclass

template<class TInputList , class TOutputList , class TFunction >

typedef otb::ObjectListToObjectListFilter<TInputList, TOutputList> otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::Superclass

Definition at line 46 of file otbUnaryFunctorObjectListFilter.h.

Constructor & Destructor Documentation

UnaryFunctorObjectListFilter() [1/2]

template<class TInputList , class TOutputList , class TFunction >

otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::UnaryFunctorObjectListFilter

protected

Constructor

Definition at line 35 of file otbUnaryFunctorObjectListFilter.hxx.

~UnaryFunctorObjectListFilter()

template<class TInputList , class TOutputList , class TFunction >

otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::~UnaryFunctorObjectListFilter ( )

inlineoverrideprotected

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 97 of file otbUnaryFunctorObjectListFilter.h.

UnaryFunctorObjectListFilter() [2/2]

template<class TInputList , class TOutputList , class TFunction >

otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::UnaryFunctorObjectListFilter ( const Self &  )

privatedelete

End Multi-threading implementation

Member Function Documentation

AfterThreadedGenerateData()

template<class TInputList , class TOutputList , class TFunction >

void otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::AfterThreadedGenerateData

overrideprotectedvirtual

Multi-threading implementation

Reimplemented from otb::ObjectListToObjectListFilter< TInputList, TOutputList >.

Definition at line 69 of file otbUnaryFunctorObjectListFilter.hxx.

CreateAnother()

template<class TInputList , class TOutputList , class TFunction >

virtual::itk::LightObject::Pointer otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::CreateAnother

(

void

)

const

GetFunctor() [1/2]

template<class TInputList , class TOutputList , class TFunction >

FunctorType& otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, 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 69 of file otbUnaryFunctorObjectListFilter.h.

GetFunctor() [2/2]

template<class TInputList , class TOutputList , class TFunction >

const FunctorType& otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::GetFunctor ( ) const

inline

Definition at line 74 of file otbUnaryFunctorObjectListFilter.h.

GetNameOfClass()

template<class TInputList , class TOutputList , class TFunction >

virtual const char* otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from otb::ObjectListToObjectListFilter< TInputList, TOutputList >.

New()

template<class TInputList , class TOutputList , class TFunction >

static Pointer otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TInputList , class TOutputList , class TFunction >

void otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::operator= ( const Self &  )

privatedelete

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).

SetFunctor()

template<class TInputList , class TOutputList , class TFunction >

void otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, 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 85 of file otbUnaryFunctorObjectListFilter.h.

ThreadedGenerateData()

template<class TInputList , class TOutputList , class TFunction >

void otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::ThreadedGenerateData ( unsigned int  startIndex, unsigned int  stopIndex, itk::ThreadIdType  threadId  )

overrideprotectedvirtual

startIndex and stopIndex represent the indices of the Objects to examine in thread threadId

Reimplemented from otb::ObjectListToObjectListFilter< TInputList, TOutputList >.

Definition at line 40 of file otbUnaryFunctorObjectListFilter.hxx.

Member Data Documentation

m_Functor

template<class TInputList , class TOutputList , class TFunction >

FunctorType otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >::m_Functor

private

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 115 of file otbUnaryFunctorObjectListFilter.h.

---

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

• otbUnaryFunctorObjectListFilter.h
• otbUnaryFunctorObjectListFilter.hxx