OTB  9.0.0
Orfeo Toolbox
Public Types | List of all members
otb::HistogramStatisticsFunction< TInputHistogram, TOutput > Class Template Reference
Group Core » Module OTBStatistics

#include <otbHistogramStatisticsFunction.h>

+ Inheritance diagram for otb::HistogramStatisticsFunction< TInputHistogram, TOutput >:
+ Collaboration diagram for otb::HistogramStatisticsFunction< TInputHistogram, TOutput >:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef TInputHistogram::AbsoluteFrequencyType FrequencyType
 
typedef TInputHistogram::MeasurementType MeasurementType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::NumericTraits< MeasurementType >::RealType RealType
 
typedef HistogramStatisticsFunction Self
 
typedef itk::HistogramAlgorithmBase< TInputHistogram > Superclass
 
typedef std::vector< TOutput > OutputType
 
OutputType m_entropy
 
OutputType m_mean
 
OutputType m_covariance
 
bool m_IsModified
 
TInputHistogram::ConstPointer m_InputHistogram
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputType GetEntropy ()
 
OutputType GetMean ()
 
OutputType GetCovariance ()
 
void SetInputHistogram (const TInputHistogram *histogram)
 
void Compute () override
 
static Pointer New ()
 
 HistogramStatisticsFunction ()
 
 ~HistogramStatisticsFunction () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateData ()
 
void CalculateEntropy ()
 
void CalculateMean ()
 
void CalculateCovariance ()
 

Detailed Description

template<class TInputHistogram, class TOutput>
class otb::HistogramStatisticsFunction< TInputHistogram, TOutput >

Computes parameters for a histogram.

You plug in the target histogram using SetInputHistogram method and get the entropy value from the histogram by calling the method GetEntropy or the GenerateData method.

Definition at line 44 of file otbHistogramStatisticsFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputHistogram , class TOutput >
typedef itk::SmartPointer<const Self> otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::ConstPointer

Definition at line 51 of file otbHistogramStatisticsFunction.h.

◆ FrequencyType

template<class TInputHistogram , class TOutput >
typedef TInputHistogram::AbsoluteFrequencyType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::FrequencyType

Definition at line 54 of file otbHistogramStatisticsFunction.h.

◆ MeasurementType

template<class TInputHistogram , class TOutput >
typedef TInputHistogram::MeasurementType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::MeasurementType

Definition at line 53 of file otbHistogramStatisticsFunction.h.

◆ OutputType

template<class TInputHistogram , class TOutput >
typedef std::vector<TOutput> otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::OutputType

Typedef for the output type

Definition at line 59 of file otbHistogramStatisticsFunction.h.

◆ Pointer

template<class TInputHistogram , class TOutput >
typedef itk::SmartPointer<Self> otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::Pointer

Definition at line 50 of file otbHistogramStatisticsFunction.h.

◆ RealType

template<class TInputHistogram , class TOutput >
typedef itk::NumericTraits<MeasurementType>::RealType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::RealType

Definition at line 55 of file otbHistogramStatisticsFunction.h.

◆ Self

template<class TInputHistogram , class TOutput >
typedef HistogramStatisticsFunction otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::Self

Standard class typedefs.

Definition at line 48 of file otbHistogramStatisticsFunction.h.

◆ Superclass

template<class TInputHistogram , class TOutput >
typedef itk::HistogramAlgorithmBase<TInputHistogram> otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::Superclass

Definition at line 49 of file otbHistogramStatisticsFunction.h.

Constructor & Destructor Documentation

◆ HistogramStatisticsFunction()

template<class TInputHistogram , class TOutput >
otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::HistogramStatisticsFunction
protected

Typedef for the output type

Definition at line 31 of file otbHistogramStatisticsFunction.hxx.

◆ ~HistogramStatisticsFunction()

template<class TInputHistogram , class TOutput >
otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::~HistogramStatisticsFunction ( )
inlineoverrideprotected

Typedef for the output type

Definition at line 94 of file otbHistogramStatisticsFunction.h.

Member Function Documentation

◆ CalculateCovariance()

template<class TInputHistogram , class TOutput >
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::CalculateCovariance
protected

Calculate covariance value

Definition at line 127 of file otbHistogramStatisticsFunction.hxx.

◆ CalculateEntropy()

template<class TInputHistogram , class TOutput >
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::CalculateEntropy
protected

Calculate the entropy value

Definition at line 67 of file otbHistogramStatisticsFunction.hxx.

◆ CalculateMean()

template<class TInputHistogram , class TOutput >
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::CalculateMean
protected

Calculate mean value

Definition at line 95 of file otbHistogramStatisticsFunction.hxx.

◆ Compute()

template<class TInputHistogram , class TOutput >
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::Compute ( )
inlineoverride

Calculates the thresholds and save them

Definition at line 87 of file otbHistogramStatisticsFunction.h.

References otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::GenerateData().

◆ CreateAnother()

template<class TInputHistogram , class TOutput >
virtual::itk::LightObject::Pointer otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::CreateAnother ( void  ) const

Typedef for the output type

◆ GenerateData()

template<class TInputHistogram , class TOutput >
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::GenerateData
protected

Calculates the thresholds and save them

Definition at line 163 of file otbHistogramStatisticsFunction.hxx.

Referenced by otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::Compute().

◆ GetCovariance()

template<class TInputHistogram , class TOutput >
HistogramStatisticsFunction< TInputHistogram, TOutput >::OutputType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::GetCovariance

Returns the covariance value from histogram

Definition at line 57 of file otbHistogramStatisticsFunction.hxx.

◆ GetEntropy()

template<class TInputHistogram , class TOutput >
HistogramStatisticsFunction< TInputHistogram, TOutput >::OutputType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::GetEntropy

Returns the entropy value

Definition at line 37 of file otbHistogramStatisticsFunction.hxx.

◆ GetMean()

template<class TInputHistogram , class TOutput >
HistogramStatisticsFunction< TInputHistogram, TOutput >::OutputType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::GetMean

Returns the mean value from histogram

Definition at line 47 of file otbHistogramStatisticsFunction.hxx.

◆ GetNameOfClass()

template<class TInputHistogram , class TOutput >
virtual const char* otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::GetNameOfClass ( ) const
virtual

Standard Macros

◆ New()

template<class TInputHistogram , class TOutput >
static Pointer otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::New ( )
static

Typedef for the output type

◆ PrintSelf()

template<class TInputHistogram , class TOutput >
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Typedef for the output type

Definition at line 173 of file otbHistogramStatisticsFunction.hxx.

◆ SetInputHistogram()

template<class TInputHistogram , class TOutput >
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram ( const TInputHistogram *  histogram)
inline

Stores the histogram pointer

Definition at line 75 of file otbHistogramStatisticsFunction.h.

References otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_InputHistogram, and otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_IsModified.

Member Data Documentation

◆ m_covariance

template<class TInputHistogram , class TOutput >
OutputType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_covariance
private

Typedef for the output type

Definition at line 115 of file otbHistogramStatisticsFunction.h.

◆ m_entropy

template<class TInputHistogram , class TOutput >
OutputType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_entropy
private

Typedef for the output type

Definition at line 113 of file otbHistogramStatisticsFunction.h.

◆ m_InputHistogram

template<class TInputHistogram , class TOutput >
TInputHistogram::ConstPointer otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_InputHistogram
private

Target histogram data pointer

Definition at line 119 of file otbHistogramStatisticsFunction.h.

Referenced by otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram().

◆ m_IsModified

template<class TInputHistogram , class TOutput >
bool otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_IsModified
private

Typedef for the output type

Definition at line 116 of file otbHistogramStatisticsFunction.h.

Referenced by otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram().

◆ m_mean

template<class TInputHistogram , class TOutput >
OutputType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_mean
private

Typedef for the output type

Definition at line 114 of file otbHistogramStatisticsFunction.h.

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