Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::HistogramStatisticsFunction< TInputHistogram, TOutput > Class Template Reference

Computes parameters for a histogram. More...

#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 std::vector< TOutput > OutputType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::NumericTraits
< MeasurementType >::RealType 
RealType
 
typedef HistogramStatisticsFunction Self
 
typedef
itk::HistogramAlgorithmBase
< TInputHistogram > 
Superclass
 
- Public Types inherited from itk::HistogramAlgorithmBase< TInputHistogram >
typedef SmartPointer< const SelfConstPointer
 
typedef TInputHistogram InputHistogramType
 
typedef SmartPointer< SelfPointer
 
typedef HistogramAlgorithmBase Self
 
typedef Object Superclass
 

Public Member Functions

void Compute ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputType GetCovariance ()
 
OutputType GetEntropy ()
 
OutputType GetMean ()
 
virtual const char * GetNameOfClass () const
 
void SetInputHistogram (const TInputHistogram *histogram)
 
- Public Member Functions inherited from itk::HistogramAlgorithmBase< TInputHistogram >
const TInputHistogram * GetInputHistogram () const
 
void SetInputHistogram (const TInputHistogram *histogram)
 
void Update ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 HistogramStatisticsFunction ()
 
virtual ~HistogramStatisticsFunction ()
 
void CalculateCovariance ()
 
void CalculateEntropy ()
 
void CalculateMean ()
 
void GenerateData ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from itk::HistogramAlgorithmBase< TInputHistogram >
 HistogramAlgorithmBase ()
 
virtual ~HistogramAlgorithmBase ()
 

Private Attributes

OutputType m_covariance
 
OutputType m_entropy
 
TInputHistogram::ConstPointer m_InputHistogram
 
bool m_IsModified
 
OutputType m_mean
 

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 38 of file otbHistogramStatisticsFunction.h.

Member Typedef Documentation

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

Definition at line 46 of file otbHistogramStatisticsFunction.h.

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

Definition at line 49 of file otbHistogramStatisticsFunction.h.

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

Definition at line 48 of file otbHistogramStatisticsFunction.h.

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

Typedef for the output type

Definition at line 54 of file otbHistogramStatisticsFunction.h.

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

Definition at line 45 of file otbHistogramStatisticsFunction.h.

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

Definition at line 50 of file otbHistogramStatisticsFunction.h.

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

Standard class typedefs.

Definition at line 43 of file otbHistogramStatisticsFunction.h.

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

Definition at line 44 of file otbHistogramStatisticsFunction.h.

Constructor & Destructor Documentation

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

Definition at line 29 of file otbHistogramStatisticsFunction.txx.

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

Definition at line 88 of file otbHistogramStatisticsFunction.h.

Member Function Documentation

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

Calculate covariance value

Definition at line 137 of file otbHistogramStatisticsFunction.txx.

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

Calculate the entropy value

Definition at line 73 of file otbHistogramStatisticsFunction.txx.

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

Calculate mean value

Definition at line 103 of file otbHistogramStatisticsFunction.txx.

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

Calculates the thresholds and save them

Definition at line 176 of file otbHistogramStatisticsFunction.txx.

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

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

Returns the covariance value from histogram

Definition at line 61 of file otbHistogramStatisticsFunction.txx.

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.txx.

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

Returns the mean value from histogram

Definition at line 49 of file otbHistogramStatisticsFunction.txx.

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

Standard Macros

Reimplemented from itk::HistogramAlgorithmBase< TInputHistogram >.

template<class TInputHistogram, class TOutput>
static Pointer otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::New ( )
static
template<class TInputHistogram , class TOutput >
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual
template<class TInputHistogram, class TOutput>
void otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram ( const TInputHistogram *  histogram)
inline

Member Data Documentation

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

Definition at line 109 of file otbHistogramStatisticsFunction.h.

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

Definition at line 107 of file otbHistogramStatisticsFunction.h.

template<class TInputHistogram, class TOutput>
TInputHistogram::ConstPointer otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_InputHistogram
private
template<class TInputHistogram, class TOutput>
bool otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_IsModified
private
template<class TInputHistogram, class TOutput>
OutputType otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::m_mean
private

Definition at line 108 of file otbHistogramStatisticsFunction.h.


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