OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor > Class Template Reference

#include <otbSOMWithMissingValue.h>

+ Inheritance diagram for otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >:
+ Collaboration diagram for otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef MapType::DistancePointerType DistancePointerType
 
typedef MapType::DistanceType DistanceType
 
typedef MapType::IndexType IndexType
 
typedef ListSampleType::Pointer ListSamplePointerType
 
typedef TListSample ListSampleType
 
typedef MapType::Pointer MapPointerType
 
typedef TMap MapType
 
typedef MapType::PixelType NeuronType
 
typedef itk::SmartPointer< SelfPointer
 
typedef MapType::RegionType RegionType
 
typedef SOMWithMissingValue Self
 
typedef MapType::SizeType SizeType
 
typedef PeriodicSOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor > Superclass
 
typedef NeuronType::ValueType ValueType
 
- Public Types inherited from otb::PeriodicSOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef MapType::IndexType IndexType
 
typedef ListSampleType::Pointer ListSamplePointerType
 
typedef TListSample ListSampleType
 
typedef MapType::Pointer MapPointerType
 
typedef TMap MapType
 
typedef MapType::PixelType NeuronType
 
typedef itk::SmartPointer< SelfPointer
 
typedef MapType::RegionType RegionType
 
typedef PeriodicSOM Self
 
typedef MapType::SizeType SizeType
 
typedef SOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctorSuperclass
 
typedef NeuronType::ValueType ValueType
 
- Public Types inherited from otb::SOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef MapType::IndexType IndexType
 
typedef ListSampleType::Pointer ListSamplePointerType
 
typedef TListSample ListSampleType
 
typedef MapType::Pointer MapPointerType
 
typedef TMap MapType
 
typedef MapType::PixelType NeuronType
 
typedef itk::SmartPointer< SelfPointer
 
typedef MapType::RegionType RegionType
 
typedef SOM Self
 
typedef MapType::SizeType SizeType
 
typedef Functor::CzihoSOMLearningBehaviorFunctor SOMLearningBehaviorFunctorType
 
typedef Functor::CzihoSOMNeighborhoodBehaviorFunctor SOMNeighborhoodBehaviorFunctorType
 
typedef itk::ImageSource< TMap > Superclass
 
typedef NeuronType::ValueType ValueType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::PeriodicSOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::SOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void SetNumberOfIterations (unsigned int _arg)
 
virtual unsigned int GetNumberOfIterations ()
 
virtual void SetBetaInit (double _arg)
 
virtual double GetBetaInit ()
 
virtual void SetBetaEnd (double _arg)
 
virtual double GetBetaEnd ()
 
virtual void SetMinWeight (ValueType _arg)
 
virtual ValueType GetMinWeight ()
 
virtual void SetMaxWeight (ValueType _arg)
 
virtual ValueType GetMaxWeight ()
 
virtual void SetMapSize (SizeType _arg)
 
virtual SizeType GetMapSize ()
 
virtual void SetNeighborhoodSizeInit (SizeType _arg)
 
virtual SizeType GetNeighborhoodSizeInit ()
 
virtual void SetRandomInit (bool _arg)
 
virtual bool GetRandomInit ()
 
virtual void SetSeed (unsigned int _arg)
 
virtual unsigned int GetSeed ()
 
 itkGetObjectMacro (ListSample, ListSampleType)
 
virtual void SetListSample (ListSampleType *_arg)
 
void SetBetaFunctor (const SOMLearningBehaviorFunctorType &functor)
 
void SetNeighborhoodSizeFunctor (const SOMNeighborhoodBehaviorFunctorType &functor)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::PeriodicSOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
static Pointer New ()
 
- Static Public Member Functions inherited from otb::SOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
static Pointer New ()
 

Protected Member Functions

void AllocateOutputs () override
 
void GenerateData (void) override
 
void GenerateOutputInformation () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 SOMWithMissingValue ()
 
void Step (unsigned int currentIteration) override
 
void UpdateMap (const NeuronType &sample, double beta, SizeType &radius) override
 
 ~SOMWithMissingValue () override
 
- Protected Member Functions inherited from otb::PeriodicSOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
void AllocateOutputs () override
 
void GenerateData (void) override
 
void GenerateOutputInformation () override
 
 PeriodicSOM ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void Step (unsigned int currentIteration) override
 
void UpdateMap (const NeuronType &sample, double beta, SizeType &radius) override
 
 ~PeriodicSOM () override
 
- Protected Member Functions inherited from otb::SOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
 SOM ()
 
 ~SOM () override
 
void GenerateOutputInformation () override
 
void AllocateOutputs () override
 
void GenerateData (void) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Private Member Functions

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

Additional Inherited Members

- Static Public Attributes inherited from otb::SOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >
static const unsigned int MapDimension
 

Detailed Description

template<class TListSample, class TMap, class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
class otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >

This class implements SOM training with missing value.

The distance between vectors that may have missing components is holded by the EuclideanDistanceMetricWithMissingValue class in the SOMMap distance template. Nevertheless, this class re-implements the UpdateMap method to adapt the evaluation of each component of the 'newNeuron' when dealing with missing values.

TMap has to be templeted with EuclideanDistanceMetricWithMissingValuePow2

See also
SOMMap
PeriodicSOM
EuclideanDistanceMetricWithMissingValue

Definition at line 49 of file otbSOMWithMissingValue.h.

Member Typedef Documentation

◆ ConstPointer

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef itk::SmartPointer<const Self> otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::ConstPointer

Definition at line 57 of file otbSOMWithMissingValue.h.

◆ DistancePointerType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef MapType::DistancePointerType otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::DistancePointerType

Definition at line 70 of file otbSOMWithMissingValue.h.

◆ DistanceType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef MapType::DistanceType otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::DistanceType

Definition at line 69 of file otbSOMWithMissingValue.h.

◆ IndexType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef MapType::IndexType otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::IndexType

Definition at line 65 of file otbSOMWithMissingValue.h.

◆ ListSamplePointerType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef ListSampleType::Pointer otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::ListSamplePointerType

Definition at line 60 of file otbSOMWithMissingValue.h.

◆ ListSampleType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef TListSample otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::ListSampleType

Definition at line 59 of file otbSOMWithMissingValue.h.

◆ MapPointerType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef MapType::Pointer otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::MapPointerType

Definition at line 68 of file otbSOMWithMissingValue.h.

◆ MapType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef TMap otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::MapType

Definition at line 62 of file otbSOMWithMissingValue.h.

◆ NeuronType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef MapType::PixelType otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::NeuronType

Definition at line 63 of file otbSOMWithMissingValue.h.

◆ Pointer

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef itk::SmartPointer<Self> otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Pointer

Definition at line 56 of file otbSOMWithMissingValue.h.

◆ RegionType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef MapType::RegionType otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::RegionType

Definition at line 67 of file otbSOMWithMissingValue.h.

◆ Self

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef SOMWithMissingValue otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Self

Standard typedefs

Definition at line 54 of file otbSOMWithMissingValue.h.

◆ SizeType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef MapType::SizeType otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SizeType

Definition at line 66 of file otbSOMWithMissingValue.h.

◆ Superclass

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef PeriodicSOM<TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor> otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Superclass

Definition at line 55 of file otbSOMWithMissingValue.h.

◆ ValueType

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
typedef NeuronType::ValueType otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::ValueType

Definition at line 64 of file otbSOMWithMissingValue.h.

Constructor & Destructor Documentation

◆ SOMWithMissingValue() [1/2]

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SOMWithMissingValue
protected

Constructor

Definition at line 34 of file otbSOMWithMissingValue.hxx.

◆ ~SOMWithMissingValue()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::~SOMWithMissingValue
overrideprotected

Destructor

Definition at line 39 of file otbSOMWithMissingValue.hxx.

◆ SOMWithMissingValue() [2/2]

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SOMWithMissingValue ( const Self )
privatedelete

Member Function Documentation

◆ AllocateOutputs()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
void otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::AllocateOutputs ( )
inlineoverrideprotected

Output allocation redefinition

Definition at line 92 of file otbSOMWithMissingValue.h.

◆ CreateAnother()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual::itk::LightObject::Pointer otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::CreateAnother ( void  ) const

◆ GenerateData()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
void otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GenerateData ( void  )
inlineoverrideprotected

Main computation method

Definition at line 98 of file otbSOMWithMissingValue.h.

◆ GenerateOutputInformation()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
void otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GenerateOutputInformation ( )
inlineoverrideprotected

Output information redefinition

Definition at line 86 of file otbSOMWithMissingValue.h.

◆ GetNameOfClass()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual const char* otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetNameOfClass ( ) const
virtual

Runtime information macro

◆ New()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
static Pointer otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::New ( )
static

Creation through object factory macro

◆ operator=()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
void otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::operator= ( const Self )
privatedelete

◆ PrintSelf()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
void otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

PrintSelf method

Definition at line 108 of file otbSOMWithMissingValue.hxx.

◆ Step()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
void otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Step ( unsigned int  currentIteration)
inlineoverrideprotectedvirtual

◆ UpdateMap()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
void otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::UpdateMap ( const NeuronType sample,
double  beta,
SizeType radius 
)
overrideprotectedvirtual

Update the output map with a new sample, depending on the availability of the data

Update the output map with a new sample by including the case when some components of this new sample may be missing.

Parameters
sampleThe new sample to learn,
betaThe learning coefficient,
radiusThe radius of the nieghbourhood.

Reimplemented from otb::SOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >.

Definition at line 51 of file otbSOMWithMissingValue.hxx.


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