OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::Statistics::GaussianModelComponent< TSample > Class Template Reference

#include <otbGaussianModelComponent.h>

+ Inheritance diagram for otb::Statistics::GaussianModelComponent< TSample >:
+ Collaboration diagram for otb::Statistics::GaussianModelComponent< TSample >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
itk::Statistics::CovarianceSampleFilter
< TSample > 
CovarianceEstimatorType
 
typedef
CovarianceEstimatorType::MatrixType 
CovarianceType
 
typedef
NativeMembershipFunctionType::MeanVectorType 
MeanVectorType
 
typedef
Superclass::MeasurementVectorSizeType 
MeasurementVectorSizeType
 
typedef
Superclass::MeasurementVectorType 
MeasurementVectorType
 
typedef
Superclass::MembershipFunctionType 
MembershipFunctionType
 
typedef
itk::Statistics::GaussianMembershipFunction
< MeasurementVectorType
NativeMembershipFunctionType
 
typedef Superclass::ParametersType ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef GaussianModelComponent Self
 
typedef ModelComponentBase
< TSample > 
Superclass
 
- Public Types inherited from otb::Statistics::ModelComponentBase< TSample >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
TSample::MeasurementVectorSizeType 
MeasurementVectorSizeType
 
typedef
TSample::MeasurementVectorType 
MeasurementVectorType
 
typedef
itk::Statistics::MembershipFunctionBase
< MeasurementVectorType
MembershipFunctionType
 
typedef itk::Array< double > ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ModelComponentBase Self
 
typedef itk::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 SetParameters (const ParametersType &parameters)
 
void SetSample (const TSample *sample) override
 
void ShowParameters (std::ostream &os, itk::Indent indent) const override
 
- Public Member Functions inherited from otb::Statistics::ModelComponentBase< TSample >
double Cdf (MeasurementVectorType &measurements)
 
const TSample * GetSample () const
 
void SetCdfMembershipFunction (MembershipFunctionType *function)
 
virtual void Update ()
 
MembershipFunctionTypeGetPdfMembershipFunction ()
 
MembershipFunctionTypeGetCdfMembershipFunction ()
 
void SetParameters (const ParametersType &parameters)
 
ParametersType GetParameters ()
 
double Evaluate (MeasurementVectorType &measurements)
 
double Pdf (MeasurementVectorType &measurements)
 
- 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
 

Protected Member Functions

 GaussianModelComponent ()
 
void GenerateData () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~GaussianModelComponent () override
 
- Protected Member Functions inherited from otb::Statistics::ModelComponentBase< TSample >
int IsSampleModified ()
 
 ModelComponentBase ()
 
void SetPdfMembershipFunction (MembershipFunctionType *function)
 
 ~ModelComponentBase () override
 
- 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 Member Functions

 GaussianModelComponent (const Self &)=delete
 
void operator= (const Self &)=delete
 

Private Attributes

CovarianceType m_Covariance
 
CovarianceEstimatorType::Pointer m_CovarianceEstimator
 
NativeMembershipFunctionType::Pointer m_GaussianMembershipFunction
 
MeanVectorType m_Mean
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Additional Inherited Members

- Static Public Member Functions inherited from otb::Statistics::ModelComponentBase< TSample >
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 Attributes inherited from otb::Statistics::ModelComponentBase< TSample >
MembershipFunctionTypem_CdfFunction
 
ParametersType m_Parameters
 
MembershipFunctionTypem_PdfFunction
 
int m_SampleModified
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TSample>
class otb::Statistics::GaussianModelComponent< TSample >

is a component (derived from ModelComponentBase) for Gaussian class. This class is used in SEMClassifier

Recent API changes: N/A

See Also
ModelComponentBase, SEMClassifier

Definition at line 48 of file otbGaussianModelComponent.h.

Member Typedef Documentation

template<class TSample >
typedef itk::SmartPointer<const Self> otb::Statistics::GaussianModelComponent< TSample >::ConstPointer

Definition at line 56 of file otbGaussianModelComponent.h.

Types of the mean and the covariance calculator that will update this component's distribution parameters

Definition at line 77 of file otbGaussianModelComponent.h.

types of the covariance to be used by the NativeMembershipFunctionType

Definition at line 81 of file otbGaussianModelComponent.h.

Definition at line 73 of file otbGaussianModelComponent.h.

template<class TSample >
typedef Superclass::MeasurementVectorSizeType otb::Statistics::GaussianModelComponent< TSample >::MeasurementVectorSizeType

Definition at line 66 of file otbGaussianModelComponent.h.

template<class TSample >
typedef Superclass::MeasurementVectorType otb::Statistics::GaussianModelComponent< TSample >::MeasurementVectorType

Typedefs from the superclass

Definition at line 60 of file otbGaussianModelComponent.h.

template<class TSample >
typedef Superclass::MembershipFunctionType otb::Statistics::GaussianModelComponent< TSample >::MembershipFunctionType

Definition at line 67 of file otbGaussianModelComponent.h.

Type of the membership function. Gaussian density function

Definition at line 72 of file otbGaussianModelComponent.h.

template<class TSample >
typedef Superclass::ParametersType otb::Statistics::GaussianModelComponent< TSample >::ParametersType

Definition at line 68 of file otbGaussianModelComponent.h.

template<class TSample >
typedef itk::SmartPointer<Self> otb::Statistics::GaussianModelComponent< TSample >::Pointer

Definition at line 55 of file otbGaussianModelComponent.h.

template<class TSample >
typedef GaussianModelComponent otb::Statistics::GaussianModelComponent< TSample >::Self

Standard class typedefs.

Definition at line 53 of file otbGaussianModelComponent.h.

template<class TSample >
typedef ModelComponentBase<TSample> otb::Statistics::GaussianModelComponent< TSample >::Superclass

Definition at line 54 of file otbGaussianModelComponent.h.

Constructor & Destructor Documentation

template<class TSample >
otb::Statistics::GaussianModelComponent< TSample >::GaussianModelComponent ( )
protected

Definition at line 38 of file otbGaussianModelComponent.hxx.

template<class TSample >
otb::Statistics::GaussianModelComponent< TSample >::~GaussianModelComponent ( )
inlineoverrideprotected

Definition at line 95 of file otbGaussianModelComponent.h.

template<class TSample >
otb::Statistics::GaussianModelComponent< TSample >::GaussianModelComponent ( const Self )
privatedelete

Member Function Documentation

template<class TSample >
virtual::itk::LightObject::Pointer otb::Statistics::GaussianModelComponent< TSample >::CreateAnother ( void  ) const
virtual

Standard Macros

Reimplemented from otb::Statistics::ModelComponentBase< TSample >.

template<class TSample >
void otb::Statistics::GaussianModelComponent< TSample >::GenerateData ( void  )
overrideprotectedvirtual
template<class TSample >
virtual const char* otb::Statistics::GaussianModelComponent< TSample >::GetNameOfClass ( ) const
virtual

Standard Macros

Reimplemented from otb::Statistics::ModelComponentBase< TSample >.

template<class TSample >
static Pointer otb::Statistics::GaussianModelComponent< TSample >::New ( )
static

Standard Macros

template<class TSample >
void otb::Statistics::GaussianModelComponent< TSample >::operator= ( const Self )
privatedelete
template<class TSample >
void otb::Statistics::GaussianModelComponent< TSample >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from otb::Statistics::ModelComponentBase< TSample >.

Definition at line 47 of file otbGaussianModelComponent.hxx.

template<class TSample >
void otb::Statistics::GaussianModelComponent< TSample >::SetParameters ( const ParametersType parameters)

Sets the component's distribution parameters. e.g. Then user can call directly Pdf( MeasurementVectorType & )

Definition at line 108 of file otbGaussianModelComponent.hxx.

References itk::Array< TValue >::SetSize().

template<class TSample >
void otb::Statistics::GaussianModelComponent< TSample >::SetSample ( const TSample *  sample)
overridevirtual

Sets the input sample

Reimplemented from otb::Statistics::ModelComponentBase< TSample >.

Definition at line 79 of file otbGaussianModelComponent.hxx.

template<class TSample >
void otb::Statistics::GaussianModelComponent< TSample >::ShowParameters ( std::ostream &  os,
itk::Indent  indent 
) const
overridevirtual

Show the parameters in a minimal form in comparison to PrintSelf

Reimplemented from otb::Statistics::ModelComponentBase< TSample >.

Definition at line 59 of file otbGaussianModelComponent.hxx.

Member Data Documentation

template<class TSample >
CovarianceType otb::Statistics::GaussianModelComponent< TSample >::m_Covariance
private

Definition at line 109 of file otbGaussianModelComponent.h.

template<class TSample >
CovarianceEstimatorType::Pointer otb::Statistics::GaussianModelComponent< TSample >::m_CovarianceEstimator
private

Definition at line 106 of file otbGaussianModelComponent.h.

template<class TSample >
NativeMembershipFunctionType::Pointer otb::Statistics::GaussianModelComponent< TSample >::m_GaussianMembershipFunction
private

Definition at line 104 of file otbGaussianModelComponent.h.

template<class TSample >
MeanVectorType otb::Statistics::GaussianModelComponent< TSample >::m_Mean
private

Definition at line 108 of file otbGaussianModelComponent.h.


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