OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::HistogramStatisticsFunction< TInputHistogram, TOutput > Class Template Reference

#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 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

void Compute ()
 
OutputType GetCovariance ()
 
OutputType GetEntropy ()
 
OutputType GetMean ()
 
void SetInputHistogram (const TInputHistogram *histogram)
 
- Public Member Functions inherited from itk::HistogramAlgorithmBase< TInputHistogram >
const TInputHistogram * GetInputHistogram () const
 
void SetInputHistogram (const TInputHistogram *histogram)
 
void Update ()
 
- 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 (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
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 ITK_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) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- 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
 

Protected Member Functions

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

OutputType m_covariance
 
OutputType m_entropy
 
TInputHistogram::ConstPointer m_InputHistogram
 
bool m_IsModified
 
OutputType m_mean
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
static Pointer New ()
 

Additional Inherited Members

- 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 Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

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

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

Definition at line 52 of file otbHistogramStatisticsFunction.h.

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

Definition at line 51 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 57 of file otbHistogramStatisticsFunction.h.

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

Definition at line 48 of file otbHistogramStatisticsFunction.h.

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

Definition at line 53 of file otbHistogramStatisticsFunction.h.

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

Standard class typedefs.

Definition at line 46 of file otbHistogramStatisticsFunction.h.

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

Definition at line 47 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 93 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
virtual

Standard Macros

Reimplemented from itk::Object.

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

Standard Macros

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

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

Definition at line 112 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 113 of file otbHistogramStatisticsFunction.h.


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