OTB  6.7.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

#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< SelfPointer
 
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< SelfPointer
 
typedef ObjectListSource Self
 
typedef itk::ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const InputListTypeGetInput (void)
 
virtual const char * GetNameOfClass () const
 
virtual void SetInput (const InputListType *input)
 
- Public Member Functions inherited from otb::ObjectListSource< TOutputList >
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void GraftOutput (itk::DataObject *graft)
 
OutputListTypeGetOutput (void)
 
OutputListTypeGetOutput (DataObjectPointerArraySizeType idx)
 
void GraftNthOutput (DataObjectPointerArraySizeType idx, itk::DataObject *graft)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ObjectListSource< TOutputList >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
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 () override
 
 ObjectListSource ()
 
virtual void AllocateOutputs ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Protected Attributes

OutputListForThreadType m_ObjectListPerThread
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

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

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

Definition at line 53 of file otbObjectListToObjectListFilter.h.

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

Definition at line 70 of file otbObjectListToObjectListFilter.h.

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

Definition at line 66 of file otbObjectListToObjectListFilter.h.

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

Definition at line 64 of file otbObjectListToObjectListFilter.h.

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

Some typedefs.

Definition at line 59 of file otbObjectListToObjectListFilter.h.

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

Definition at line 67 of file otbObjectListToObjectListFilter.h.

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

Multi-threading implementation

Definition at line 90 of file otbObjectListToObjectListFilter.h.

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

Definition at line 65 of file otbObjectListToObjectListFilter.h.

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

Definition at line 63 of file otbObjectListToObjectListFilter.h.

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

Definition at line 68 of file otbObjectListToObjectListFilter.h.

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

Definition at line 52 of file otbObjectListToObjectListFilter.h.

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

Standard class typedefs.

Definition at line 50 of file otbObjectListToObjectListFilter.h.

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

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

Constructor

Definition at line 35 of file otbObjectListToObjectListFilter.hxx.

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

Destructor

Definition at line 81 of file otbObjectListToObjectListFilter.h.

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

End Multi-threading implementation

Member Function Documentation

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

Definition at line 126 of file otbObjectListToObjectListFilter.hxx.

template<class TInputList, class TOutputList>
virtual::itk::LightObject::Pointer otb::ObjectListToObjectListFilter< TInputList, TOutputList >::CreateAnother ( void  ) const
virtual
template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::GenerateData ( void  )
overrideprotectedvirtual
template<class TInputList , class TOutputList >
const ObjectListToObjectListFilter< TInputList, TOutputList >::InputListType * otb::ObjectListToObjectListFilter< TInputList, TOutputList >::GetInput ( void  )
template<class TInputList, class TOutputList>
virtual const char* otb::ObjectListToObjectListFilter< TInputList, TOutputList >::GetNameOfClass ( ) const
virtual
template<class TInputList, class TOutputList>
static Pointer otb::ObjectListToObjectListFilter< TInputList, TOutputList >::New ( )
static

Method for creation through the object factory.

template<class TInputList, class TOutputList>
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::operator= ( const Self )
privatedelete
template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

PrintSelf method

PrintSelf Method

Reimplemented from otb::ObjectListSource< TOutputList >.

Definition at line 191 of file otbObjectListToObjectListFilter.hxx.

template<class TInputList , class TOutputList >
void otb::ObjectListToObjectListFilter< TInputList, TOutputList >::SetInput ( const InputListType input)
virtual
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 67 of file otbObjectListToObjectListFilter.hxx.

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 134 of file otbObjectListToObjectListFilter.hxx.

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 151 of file otbObjectListToObjectListFilter.hxx.

References otb::ObjectListToObjectListFilter< TInputList, TOutputList >::ThreadStruct::Filter, and ITK_THREAD_RETURN_VALUE.

Member Data Documentation

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

Definition at line 114 of file otbObjectListToObjectListFilter.h.


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