OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::PathListToHistogramGenerator< TPath, TFunction > Class Template Reference
Group Core » Module OTBPath

#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< PathType > PathListType
 
typedef PathType::Pointer PathPointer
 
typedef TPath PathType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef TFunction::OutputType RealType
 
typedef PathListToHistogramGenerator Self
 
typedef HistogramType::SizeType SizeType
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void GraftNthOutput (unsigned int idx, itk::DataObject *graft)
 
void GraftOutput (itk::DataObject *graft)
 

Static Public Member Functions

static Pointer New ()
 
GeneratorPointer m_HistogramGenerator
 
void SetInput (const PathListType *path)
 
const PathListType * GetInput () const
 
const HistogramType * GetOutput () const
 
void SetNumberOfBins (const SizeType &size)
 
void SetMarginalScale (double marginalScale)
 
void SetHistogramMin (const MeasurementVectorType &histogramMin)
 
void SetHistogramMax (const MeasurementVectorType &histogramMax)
 
void SetAutoMinMax (bool autoMinMax)
 
 PathListToHistogramGenerator ()
 
 ~PathListToHistogramGenerator () override
 
void GenerateData () override
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

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

◆ ConstPointer

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

Definition at line 56 of file otbPathListToHistogramGenerator.h.

◆ DataObjectPointer

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

DataObject typedef

Definition at line 90 of file otbPathListToHistogramGenerator.h.

◆ DataObjectPointerArraySizeType

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

Definition at line 91 of file otbPathListToHistogramGenerator.h.

◆ FrequencyContainerType

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

Definition at line 78 of file otbPathListToHistogramGenerator.h.

◆ FunctionType

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

Definition at line 68 of file otbPathListToHistogramGenerator.h.

◆ GeneratorPointer

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

Definition at line 82 of file otbPathListToHistogramGenerator.h.

◆ GeneratorType

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

Definition at line 81 of file otbPathListToHistogramGenerator.h.

◆ HistogramConstPointer

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

Definition at line 85 of file otbPathListToHistogramGenerator.h.

◆ HistogramPointer

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

Definition at line 84 of file otbPathListToHistogramGenerator.h.

◆ HistogramType

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

Definition at line 79 of file otbPathListToHistogramGenerator.h.

◆ ListSampleConstPointer

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

Definition at line 76 of file otbPathListToHistogramGenerator.h.

◆ ListSamplePointer

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

Definition at line 75 of file otbPathListToHistogramGenerator.h.

◆ ListSampleType

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

Definition at line 74 of file otbPathListToHistogramGenerator.h.

◆ ListSampleVectorType

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

Definition at line 73 of file otbPathListToHistogramGenerator.h.

◆ MeasurementType

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

Definition at line 72 of file otbPathListToHistogramGenerator.h.

◆ MeasurementVectorType

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

Definition at line 87 of file otbPathListToHistogramGenerator.h.

◆ PathListType

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

Definition at line 66 of file otbPathListToHistogramGenerator.h.

◆ PathPointer

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

Definition at line 65 of file otbPathListToHistogramGenerator.h.

◆ PathType

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

Definition at line 62 of file otbPathListToHistogramGenerator.h.

◆ Pointer

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

Definition at line 55 of file otbPathListToHistogramGenerator.h.

◆ RealType

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

Definition at line 70 of file otbPathListToHistogramGenerator.h.

◆ Self

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

Standard typedefs

Definition at line 53 of file otbPathListToHistogramGenerator.h.

◆ SizeType

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

Definition at line 86 of file otbPathListToHistogramGenerator.h.

◆ Superclass

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

Definition at line 54 of file otbPathListToHistogramGenerator.h.

Constructor & Destructor Documentation

◆ PathListToHistogramGenerator()

template<class TPath , class TFunction >
otb::PathListToHistogramGenerator< TPath, TFunction >::PathListToHistogramGenerator
protected

Set number of histogram bins

Definition at line 31 of file otbPathListToHistogramGenerator.hxx.

◆ ~PathListToHistogramGenerator()

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

Set number of histogram bins

Definition at line 118 of file otbPathListToHistogramGenerator.h.

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateData()

template<class TPath , class TFunction >
void otb::PathListToHistogramGenerator< TPath, TFunction >::GenerateData
overrideprotected

Set number of histogram bins

Definition at line 107 of file otbPathListToHistogramGenerator.hxx.

◆ GetInput()

template<class TPath , class TFunction >
const PathListToHistogramGenerator< TPath, TFunction >::PathListType * otb::PathListToHistogramGenerator< TPath, TFunction >::GetInput

Set number of histogram bins

Definition at line 49 of file otbPathListToHistogramGenerator.hxx.

◆ GetNameOfClass()

template<class TPath , class TFunction >
virtual const char* otb::PathListToHistogramGenerator< TPath, TFunction >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetOutput()

template<class TPath , class TFunction >
const PathListToHistogramGenerator< TPath, TFunction >::HistogramType * otb::PathListToHistogramGenerator< TPath, TFunction >::GetOutput

Set number of histogram bins

Definition at line 101 of file otbPathListToHistogramGenerator.hxx.

◆ GraftNthOutput()

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 72 of file otbPathListToHistogramGenerator.hxx.

◆ GraftOutput()

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

//FIXME : should be done in a HistogramSource

Definition at line 62 of file otbPathListToHistogramGenerator.hxx.

◆ MakeOutput()

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

Set number of histogram bins

Definition at line 92 of file otbPathListToHistogramGenerator.hxx.

◆ New()

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

standard New() method support

◆ PrintSelf()

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

Set number of histogram bins

Definition at line 172 of file otbPathListToHistogramGenerator.hxx.

◆ SetAutoMinMax()

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

Set number of histogram bins

Definition at line 166 of file otbPathListToHistogramGenerator.hxx.

◆ SetHistogramMax()

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

Set number of histogram bins

Definition at line 160 of file otbPathListToHistogramGenerator.hxx.

◆ SetHistogramMin()

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

Set number of histogram bins

Definition at line 154 of file otbPathListToHistogramGenerator.hxx.

◆ SetInput()

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

Set number of histogram bins

Definition at line 42 of file otbPathListToHistogramGenerator.hxx.

◆ SetMarginalScale()

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 148 of file otbPathListToHistogramGenerator.hxx.

◆ SetNumberOfBins()

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

Set number of histogram bins

Definition at line 142 of file otbPathListToHistogramGenerator.hxx.

Member Data Documentation

◆ m_HistogramGenerator

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

Set number of histogram bins

Definition at line 128 of file otbPathListToHistogramGenerator.h.

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