OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::PathListToHistogramGenerator< TPath, TFunction > Class Template Reference

#include <otbPathListToHistogramGenerator.h>

+ Inheritance diagram for otb::PathListToHistogramGenerator< TPath, TFunction >:
+ Collaboration diagram for otb::PathListToHistogramGenerator< TPath, TFunction >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Superclass::DataObjectPointer 
DataObjectPointer
 
typedef
itk::ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef
itk::Statistics::DenseFrequencyContainer2 
FrequencyContainerType
 
typedef TFunction FunctionType
 
typedef GeneratorType::Pointer GeneratorPointer
 
typedef
itk::Statistics::SampleToHistogramFilter
< ListSampleType,
HistogramType
GeneratorType
 
typedef HistogramType::ConstPointer HistogramConstPointer
 
typedef HistogramType::Pointer HistogramPointer
 
typedef
itk::Statistics::Histogram
< MeasurementType,
FrequencyContainerType
HistogramType
 
typedef
ListSampleType::ConstPointer 
ListSampleConstPointer
 
typedef ListSampleType::Pointer ListSamplePointer
 
typedef
itk::Statistics::ListSample
< ListSampleVectorType
ListSampleType
 
typedef itk::Vector
< MeasurementType, 1 > 
ListSampleVectorType
 
typedef RealType MeasurementType
 
typedef
HistogramType::MeasurementVectorType 
MeasurementVectorType
 
typedef ObjectList< PathTypePathListType
 
typedef PathType::Pointer PathPointer
 
typedef TPath PathType
 
typedef itk::SmartPointer< SelfPointer
 
typedef TFunction::OutputType RealType
 
typedef
PathListToHistogramGenerator 
Self
 
typedef HistogramType::SizeType SizeType
 
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
 
const HistogramTypeGetOutput () const
 
void GraftNthOutput (unsigned int idx, itk::DataObject *graft)
 
void GraftOutput (itk::DataObject *graft)
 
void SetNumberOfBins (const SizeType &size)
 
void SetInput (const PathListType *path)
 
const PathListTypeGetInput () const
 
void SetMarginalScale (double marginalScale)
 
void SetHistogramMin (const MeasurementVectorType &histogramMin)
 
void SetHistogramMax (const MeasurementVectorType &histogramMax)
 
void SetAutoMinMax (bool autoMinMax)
 
- 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

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

GeneratorPointer m_HistogramGenerator
 

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 TPath, class TFunction>
class otb::PathListToHistogramGenerator< TPath, TFunction >

This class generates an histogram from a list of path.

The concept of Histogram in ITK is quite generic. It has been designed to manage multiple components data. This class facilitates the computation of an histogram from a list of path. Internally it creates a List that is feed into the ListSampleToHistogramGenerator.

Definition at line 49 of file otbPathListToHistogramGenerator.h.

Member Typedef Documentation

template<class TPath, class TFunction>
typedef itk::SmartPointer<const Self> otb::PathListToHistogramGenerator< TPath, TFunction >::ConstPointer

Definition at line 56 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef Superclass::DataObjectPointer otb::PathListToHistogramGenerator< TPath, TFunction >::DataObjectPointer

DataObject typedef

Definition at line 93 of file otbPathListToHistogramGenerator.h.

Definition at line 94 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef itk::Statistics::DenseFrequencyContainer2 otb::PathListToHistogramGenerator< TPath, TFunction >::FrequencyContainerType

Definition at line 78 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef TFunction otb::PathListToHistogramGenerator< TPath, TFunction >::FunctionType

Definition at line 68 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef GeneratorType::Pointer otb::PathListToHistogramGenerator< TPath, TFunction >::GeneratorPointer

Definition at line 85 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef itk::Statistics::SampleToHistogramFilter< ListSampleType, HistogramType> otb::PathListToHistogramGenerator< TPath, TFunction >::GeneratorType

Definition at line 84 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef HistogramType::ConstPointer otb::PathListToHistogramGenerator< TPath, TFunction >::HistogramConstPointer

Definition at line 88 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef HistogramType::Pointer otb::PathListToHistogramGenerator< TPath, TFunction >::HistogramPointer

Definition at line 87 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef itk::Statistics::Histogram< MeasurementType, FrequencyContainerType > otb::PathListToHistogramGenerator< TPath, TFunction >::HistogramType

Definition at line 80 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef ListSampleType::ConstPointer otb::PathListToHistogramGenerator< TPath, TFunction >::ListSampleConstPointer

Definition at line 76 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef ListSampleType::Pointer otb::PathListToHistogramGenerator< TPath, TFunction >::ListSamplePointer

Definition at line 75 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef itk::Statistics::ListSample<ListSampleVectorType> otb::PathListToHistogramGenerator< TPath, TFunction >::ListSampleType

Definition at line 74 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef itk::Vector<MeasurementType, 1> otb::PathListToHistogramGenerator< TPath, TFunction >::ListSampleVectorType

Definition at line 73 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef RealType otb::PathListToHistogramGenerator< TPath, TFunction >::MeasurementType

Definition at line 72 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef HistogramType::MeasurementVectorType otb::PathListToHistogramGenerator< TPath, TFunction >::MeasurementVectorType

Definition at line 90 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef ObjectList<PathType> otb::PathListToHistogramGenerator< TPath, TFunction >::PathListType

Definition at line 66 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef PathType::Pointer otb::PathListToHistogramGenerator< TPath, TFunction >::PathPointer

Definition at line 65 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef TPath otb::PathListToHistogramGenerator< TPath, TFunction >::PathType

Definition at line 62 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef itk::SmartPointer<Self> otb::PathListToHistogramGenerator< TPath, TFunction >::Pointer

Definition at line 55 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef TFunction::OutputType otb::PathListToHistogramGenerator< TPath, TFunction >::RealType

Definition at line 70 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef PathListToHistogramGenerator otb::PathListToHistogramGenerator< TPath, TFunction >::Self

Standard typedefs

Definition at line 53 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef HistogramType::SizeType otb::PathListToHistogramGenerator< TPath, TFunction >::SizeType

Definition at line 89 of file otbPathListToHistogramGenerator.h.

template<class TPath, class TFunction>
typedef itk::ProcessObject otb::PathListToHistogramGenerator< TPath, TFunction >::Superclass

Definition at line 54 of file otbPathListToHistogramGenerator.h.

Constructor & Destructor Documentation

template<class TPath , class TFunction >
otb::PathListToHistogramGenerator< TPath, TFunction >::PathListToHistogramGenerator ( )
protected
template<class TPath, class TFunction>
otb::PathListToHistogramGenerator< TPath, TFunction >::~PathListToHistogramGenerator ( )
inlineoverrideprotected

Definition at line 122 of file otbPathListToHistogramGenerator.h.

Member Function Documentation

template<class TPath, class TFunction>
virtual::itk::LightObject::Pointer otb::PathListToHistogramGenerator< TPath, TFunction >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::GenerateData ( void  )
overrideprotectedvirtual
template<class TPath , class TFunction >
const PathListToHistogramGenerator< TPath, TFunction >::PathListType * otb::PathListToHistogramGenerator< TPath, TFunction >::GetInput ( void  ) const
template<class TPath, class TFunction>
virtual const char* otb::PathListToHistogramGenerator< TPath, TFunction >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TPath , class TFunction >
const PathListToHistogramGenerator< TPath, TFunction >::HistogramType * otb::PathListToHistogramGenerator< TPath, TFunction >::GetOutput ( void  ) const
template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::GraftNthOutput ( unsigned int  idx,
itk::DataObject graft 
)

//FIXME : should be done in a HistogramSource

Definition at line 83 of file otbPathListToHistogramGenerator.hxx.

References itk::DataObject::Graft().

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::GraftOutput ( itk::DataObject graft)

//FIXME : should be done in a HistogramSource

Definition at line 71 of file otbPathListToHistogramGenerator.hxx.

template<class TPath , class TFunction >
PathListToHistogramGenerator< TPath, TFunction >::DataObjectPointer otb::PathListToHistogramGenerator< TPath, TFunction >::MakeOutput ( DataObjectPointerArraySizeType  )
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

Definition at line 105 of file otbPathListToHistogramGenerator.hxx.

template<class TPath, class TFunction>
static Pointer otb::PathListToHistogramGenerator< TPath, TFunction >::New ( )
static

standard New() method support

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

Definition at line 201 of file otbPathListToHistogramGenerator.hxx.

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::SetAutoMinMax ( bool  autoMinMax)

Set marginal scale value to be passed to the histogram generator

Definition at line 193 of file otbPathListToHistogramGenerator.hxx.

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::SetHistogramMax ( const MeasurementVectorType histogramMax)

Set marginal scale value to be passed to the histogram generator

Definition at line 185 of file otbPathListToHistogramGenerator.hxx.

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::SetHistogramMin ( const MeasurementVectorType histogramMin)

Set marginal scale value to be passed to the histogram generator

Definition at line 177 of file otbPathListToHistogramGenerator.hxx.

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::SetInput ( const PathListType path)
template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::SetMarginalScale ( double  marginalScale)

Set marginal scale value to be passed to the histogram generator

Definition at line 169 of file otbPathListToHistogramGenerator.hxx.

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::SetNumberOfBins ( const SizeType size)

Set number of histogram bins

Definition at line 161 of file otbPathListToHistogramGenerator.hxx.

Member Data Documentation

template<class TPath, class TFunction>
GeneratorPointer otb::PathListToHistogramGenerator< TPath, TFunction >::m_HistogramGenerator
private

Definition at line 131 of file otbPathListToHistogramGenerator.h.


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