OTB  9.0.0
Orfeo Toolbox
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::ObjectListToObjectListFilter< TInputList, TOutputList > Class Template Reference
Group Core » Module OTBObjectList

#include <otbObjectListToObjectListFilter.h>

+ Inheritance diagram for otb::ObjectListToObjectListFilter< TInputList, TOutputList >:
+ Collaboration diagram for otb::ObjectListToObjectListFilter< TInputList, TOutputList >:

Classes

struct  ThreadStruct
 

Public Types

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
 
const InputListType * GetInput (void)
 
virtual const char * GetNameOfClass () const
 
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::ObjectListSource< TOutputList >
static Pointer New ()
 

Protected Types

typedef std::vector< OutputListPointer > OutputListForThreadType
 

Protected Member Functions

virtual void AfterThreadedGenerateData ()
 
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)
 
virtual void ThreadedGenerateData (unsigned int startIndex, unsigned int stopIndex, itk::ThreadIdType threadId)
 
 ~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

static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Protected Attributes

OutputListForThreadType m_ObjectListPerThread
 

Private Member Functions

 ObjectListToObjectListFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputList, class TOutputList>
class otb::ObjectListToObjectListFilter< TInputList, TOutputList >

Base class for filters that take an ObjectList as input and produce an ObjectList as output.

ObjectListToObjectListFilter is the base class for all process objects that output ObjectList data and require ObjectList data as input. Specifically, this class defines the SetInput() method for defining the input to a filter.

Be aware that this class is templated over the list type, not the object type. It will be typically something like otb::ObjectList<ObjectType>. This is to enable the use of class derived from ObjectList or other implementations.

Definition at line 46 of file otbObjectListToObjectListFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputList , class TOutputList >
typedef itk::SmartPointer<const Self> otb::ObjectListToObjectListFilter< TInputList, TOutputList >::ConstPointer

Definition at line 53 of file otbObjectListToObjectListFilter.h.

◆ DataObjectPointer

template<class TInputList , class TOutputList >
typedef itk::DataObject::Pointer otb::ObjectListToObjectListFilter< TInputList, TOutputList >::DataObjectPointer

Definition at line 70 of file otbObjectListToObjectListFilter.h.

◆ InputListIterator

template<class TInputList , class TOutputList >
typedef TInputList::ConstIterator otb::ObjectListToObjectListFilter< TInputList, TOutputList >::InputListIterator

Definition at line 66 of file otbObjectListToObjectListFilter.h.

◆ InputListPointer

template<class TInputList , class TOutputList >
typedef TInputList::ConstPointer otb::ObjectListToObjectListFilter< TInputList, TOutputList >::InputListPointer

Definition at line 64 of file otbObjectListToObjectListFilter.h.

◆ InputListType

template<class TInputList , class TOutputList >
typedef TInputList otb::ObjectListToObjectListFilter< TInputList, TOutputList >::InputListType

Some typedefs.

Definition at line 59 of file otbObjectListToObjectListFilter.h.

◆ InputObjectType

template<class TInputList , class TOutputList >
typedef InputListType::ObjectType otb::ObjectListToObjectListFilter< TInputList, TOutputList >::InputObjectType

Definition at line 67 of file otbObjectListToObjectListFilter.h.

◆ OutputListForThreadType

template<class TInputList , class TOutputList >
typedef std::vector<OutputListPointer> otb::ObjectListToObjectListFilter< TInputList, TOutputList >::OutputListForThreadType
protected

Multi-threading implementation

Definition at line 92 of file otbObjectListToObjectListFilter.h.

◆ OutputListPointer

template<class TInputList , class TOutputList >
typedef TOutputList::Pointer otb::ObjectListToObjectListFilter< TInputList, TOutputList >::OutputListPointer

Definition at line 65 of file otbObjectListToObjectListFilter.h.

◆ OutputListType

template<class TInputList , class TOutputList >
typedef TOutputList otb::ObjectListToObjectListFilter< TInputList, TOutputList >::OutputListType

Definition at line 63 of file otbObjectListToObjectListFilter.h.

◆ OutputObjectType

template<class TInputList , class TOutputList >
typedef OutputListType::ObjectType otb::ObjectListToObjectListFilter< TInputList, TOutputList >::OutputObjectType

Definition at line 68 of file otbObjectListToObjectListFilter.h.

◆ Pointer

template<class TInputList , class TOutputList >
typedef itk::SmartPointer<Self> otb::ObjectListToObjectListFilter< TInputList, TOutputList >::Pointer

Definition at line 52 of file otbObjectListToObjectListFilter.h.

◆ Self

template<class TInputList , class TOutputList >
typedef ObjectListToObjectListFilter otb::ObjectListToObjectListFilter< TInputList, TOutputList >::Self

Standard class typedefs.

Definition at line 50 of file otbObjectListToObjectListFilter.h.

◆ Superclass

template<class TInputList , class TOutputList >
typedef otb::ObjectListSource<TOutputList> otb::ObjectListToObjectListFilter< TInputList, TOutputList >::Superclass

Definition at line 51 of file otbObjectListToObjectListFilter.h.

Constructor & Destructor Documentation

◆ ObjectListToObjectListFilter() [1/2]

template<class TInputList , class TOutputList >
otb::ObjectListToObjectListFilter< TInputList, TOutputList >::ObjectListToObjectListFilter
protected

Constructor

Definition at line 34 of file otbObjectListToObjectListFilter.hxx.

◆ ~ObjectListToObjectListFilter()

template<class TInputList , class TOutputList >
otb::ObjectListToObjectListFilter< TInputList, TOutputList >::~ObjectListToObjectListFilter ( )
inlineoverrideprotected

Destructor

Definition at line 81 of file otbObjectListToObjectListFilter.h.

◆ ObjectListToObjectListFilter() [2/2]

template<class TInputList , class TOutputList >
otb::ObjectListToObjectListFilter< TInputList, TOutputList >::ObjectListToObjectListFilter ( const Self &  )
privatedelete

End Multi-threading implementation

Member Function Documentation

◆ AfterThreadedGenerateData()

template<class TInputList , class TOutputList >
virtual void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::AfterThreadedGenerateData ( )
inlineprotectedvirtual

Reimplemented in otb::UnaryFunctorObjectListBooleanFilter< TInputList, TOutputList, TFunction >, and otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >.

Definition at line 96 of file otbObjectListToObjectListFilter.h.

◆ BeforeThreadedGenerateData()

template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::BeforeThreadedGenerateData
protectedvirtual

Definition at line 104 of file otbObjectListToObjectListFilter.hxx.

◆ CreateAnother()

template<class TInputList , class TOutputList >
virtual::itk::LightObject::Pointer otb::ObjectListToObjectListFilter< TInputList, TOutputList >::CreateAnother ( void  ) const

◆ GenerateData()

template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::GenerateData ( void  )
overrideprotected

GenerateData

Definition at line 76 of file otbObjectListToObjectListFilter.hxx.

◆ GetInput()

template<class TInputList , class TOutputList >
const ObjectListToObjectListFilter< TInputList, TOutputList >::InputListType * otb::ObjectListToObjectListFilter< TInputList, TOutputList >::GetInput ( void  )

Definition at line 47 of file otbObjectListToObjectListFilter.hxx.

◆ GetNameOfClass()

template<class TInputList , class TOutputList >
virtual const char* otb::ObjectListToObjectListFilter< TInputList, TOutputList >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::ObjectListSource< TOutputList >.

Reimplemented in otb::UnaryFunctorObjectListBooleanFilter< TInputList, TOutputList, TFunction >, and otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >.

◆ New()

template<class TInputList , class TOutputList >
static Pointer otb::ObjectListToObjectListFilter< TInputList, TOutputList >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::operator= ( const Self &  )
privatedelete

◆ PrintSelf()

template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

PrintSelf method

PrintSelf Method

Definition at line 163 of file otbObjectListToObjectListFilter.hxx.

◆ SetInput()

template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::SetInput ( const InputListType *  input)
virtual

Definition at line 40 of file otbObjectListToObjectListFilter.hxx.

◆ SplitRequestedRegion()

template<class TInputList , class TOutputList >
int otb::ObjectListToObjectListFilter< TInputList, TOutputList >::SplitRequestedRegion ( itk::ThreadIdType  threadId,
int  threadCount,
unsigned int  requestedElements,
unsigned int &  startIndex,
unsigned int &  stopIndex 
)
protectedvirtual

Definition at line 58 of file otbObjectListToObjectListFilter.hxx.

◆ ThreadedGenerateData()

template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::ThreadedGenerateData ( unsigned int  startIndex,
unsigned int  stopIndex,
itk::ThreadIdType  threadId 
)
protectedvirtual

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

Reimplemented in otb::UnaryFunctorObjectListBooleanFilter< TInputList, TOutputList, TFunction >, and otb::UnaryFunctorObjectListFilter< TInputList, TOutputList, TFunction >.

Definition at line 110 of file otbObjectListToObjectListFilter.hxx.

◆ ThreaderCallback()

template<class TInputList , class TOutputList >
ITK_THREAD_RETURN_TYPE otb::ObjectListToObjectListFilter< TInputList, TOutputList >::ThreaderCallback ( void *  arg)
staticprotected

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

Definition at line 125 of file otbObjectListToObjectListFilter.hxx.

Member Data Documentation

◆ m_ObjectListPerThread

template<class TInputList , class TOutputList >
OutputListForThreadType otb::ObjectListToObjectListFilter< TInputList, TOutputList >::m_ObjectListPerThread
protected

Definition at line 118 of file otbObjectListToObjectListFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:18 for OTB with   doxygen 1.8.17