OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList > Class Template Reference

#include <otbListSampleSource.h>

+ Inheritance diagram for otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >:
+ Collaboration diagram for otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef
itk::ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef
OutputSampleListType::MeasurementVectorType 
OutputMeasurementVectorType
 
typedef
OutputSampleListType::ConstPointer 
OutputSampleListConstPointer
 
typedef
OutputSampleListType::Pointer 
OutputSampleListPointer
 
typedef TOutputSampleList OutputSampleListType
 
typedef
OutputMeasurementVectorType::ValueType 
OutputValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ListSampleSource 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
 
virtual const char * GetNameOfClass () const
 
OutputSampleListTypeGetOutput ()
 
- 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 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 Member Functions

 ListSampleSource ()
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~ListSampleSource () override
 
- 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 GenerateData ()
 
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 ()
 

Private Member Functions

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

Additional Inherited Members

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

Detailed Description

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
class otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >

This class is a base class for filters using ListSample as input and returning ListSample.

This filter provides pipeline support since itk::Statistics::ListSample is a DataObject the output sample list.

Definition at line 43 of file otbListSampleSource.h.

Member Typedef Documentation

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef itk::SmartPointer<const Self> otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::ConstPointer

Definition at line 51 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef itk::DataObject::Pointer otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::DataObjectPointer

ListSample is not a DataObject, we need to decorate it to push it down a ProcessObject's pipeline

Definition at line 69 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::DataObjectPointerArraySizeType

Definition at line 65 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef OutputSampleListType::MeasurementVectorType otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::OutputMeasurementVectorType

Definition at line 63 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef OutputSampleListType::ConstPointer otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::OutputSampleListConstPointer

Definition at line 62 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef OutputSampleListType::Pointer otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::OutputSampleListPointer

Definition at line 61 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef TOutputSampleList otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::OutputSampleListType

OutputSampleList typedefs

Definition at line 57 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef OutputMeasurementVectorType::ValueType otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::OutputValueType

Definition at line 64 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef itk::SmartPointer< Self > otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::Pointer

Definition at line 50 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef ListSampleSource otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::Self

Standard class typedefs

Definition at line 48 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
typedef itk::ProcessObject otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::Superclass

Definition at line 49 of file otbListSampleSource.h.

Constructor & Destructor Documentation

template<class TInputSampleList , class TOutputSampleList >
otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::ListSampleSource ( )
protected

Definition at line 31 of file otbListSampleSource.hxx.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::~ListSampleSource ( )
inlineoverrideprotected

Definition at line 80 of file otbListSampleSource.h.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::ListSampleSource ( const Self )
privatedelete

Member Function Documentation

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
virtual::itk::LightObject::Pointer otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::CreateAnother ( void  ) const
virtual
template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
virtual const char* otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::GetNameOfClass ( ) const
virtual
template<class TInputSampleList , class TOutputSampleList >
ListSampleSource< TInputSampleList, TOutputSampleList >::OutputSampleListType * otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::GetOutput ( void  )

Returns the output sample list as a data object

Definition at line 55 of file otbListSampleSource.hxx.

template<class TInputSampleList , class TOutputSampleList >
ListSampleSource< TInputSampleList, TOutputSampleList >::DataObjectPointer otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotectedvirtual

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

Definition at line 45 of file otbListSampleSource.hxx.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
static Pointer otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::New ( )
static

Method for creation through the object factory.

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
void otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::operator= ( const Self )
privatedelete
template<class TInputSampleList , class TOutputSampleList >
void otb::Statistics::ListSampleSource< TInputSampleList, TOutputSampleList >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

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