#include <otbSOM.h>

Inheritance diagram for otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >:

Collaboration diagram for otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

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< Self >	Pointer

typedef MapType::RegionType	RegionType

typedef SOM	Self

typedef MapType::SizeType	SizeType

typedef TSOMLearningBehaviorFunctor	SOMLearningBehaviorFunctorType

typedef TSOMNeighborhoodBehaviorFunctor	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

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	MapDimension = MapType::ImageDimension

SizeType	m_MapSize

unsigned int	m_NumberOfIterations

double	m_BetaInit

double	m_BetaEnd

SizeType	m_NeighborhoodSizeInit

ValueType	m_MinWeight

ValueType	m_MaxWeight

bool	m_RandomInit

unsigned int	m_Seed

ListSamplePointerType	m_ListSample

SOMLearningBehaviorFunctorType	m_BetaFunctor

SOMNeighborhoodBehaviorFunctorType	m_NeighborhoodSizeFunctor

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)

	SOM ()

	~SOM () override

void	GenerateOutputInformation () override

void	AllocateOutputs () override

void	GenerateData (void) override

virtual void	UpdateMap (const NeuronType &sample, double beta, SizeType &radius)

virtual void	Step (unsigned int currentIteration)

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

	SOM (const Self &)=delete

void	operator= (const Self &)=delete

Detailed Description

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

This class is responsible for the learning of a self organizing map from a set of vector represented by the input image (each vector is a pixel of the image).

The learning process iteratively select the best-response neuron for each input vector, enhancing its response and the response of its neighbors with respect to a certain radius, computed from an initial radius, and to a certain learning factor, decreasing at each iteration.

The behavior of the neighborhood is given by a functor (templated) which parameter is the current iteration. It returns a neighborhood of type

SizeType

.

The behavior of the learning factor (hold by a beta variable) is given by an other functor which parameter is the current iteration. It returns a beta value of type double.

The SOMMap produced as output can be either initialized with a constant custom value or randomly generated following a normal law. The seed for the random initialization can be modified.

See also: SOMMap; SOMActivationBuilder; CzihoSOMLearningBehaviorFunctor; CzihoSOMNeighborhoodBehaviorFunctor

Definition at line 60 of file otbSOM.h.

Member Typedef Documentation

◆ ConstPointer

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

typedef itk::SmartPointer<const Self> otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::ConstPointer

Definition at line 68 of file otbSOM.h.

◆ IndexType

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

typedef MapType::IndexType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::IndexType

Definition at line 81 of file otbSOM.h.

◆ ListSamplePointerType

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

typedef ListSampleType::Pointer otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::ListSamplePointerType

Definition at line 77 of file otbSOM.h.

◆ ListSampleType

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

typedef TListSample otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::ListSampleType

Definition at line 74 of file otbSOM.h.

◆ MapPointerType

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

typedef MapType::Pointer otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::MapPointerType

Definition at line 84 of file otbSOM.h.

◆ MapType

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

typedef TMap otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::MapType

Definition at line 78 of file otbSOM.h.

◆ NeuronType

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

typedef MapType::PixelType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::NeuronType

Definition at line 79 of file otbSOM.h.

◆ Pointer

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

typedef itk::SmartPointer<Self> otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Pointer

Definition at line 67 of file otbSOM.h.

◆ RegionType

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

typedef MapType::RegionType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::RegionType

Definition at line 83 of file otbSOM.h.

◆ Self

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

typedef SOM otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Self

Standard typedefs

Definition at line 65 of file otbSOM.h.

◆ SizeType

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

typedef MapType::SizeType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SizeType

Definition at line 82 of file otbSOM.h.

◆ SOMLearningBehaviorFunctorType

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

typedef TSOMLearningBehaviorFunctor otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SOMLearningBehaviorFunctorType

Definition at line 86 of file otbSOM.h.

◆ SOMNeighborhoodBehaviorFunctorType

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

typedef TSOMNeighborhoodBehaviorFunctor otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SOMNeighborhoodBehaviorFunctorType

Definition at line 87 of file otbSOM.h.

◆ Superclass

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

typedef itk::ImageSource<TMap> otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Superclass

Definition at line 66 of file otbSOM.h.

◆ ValueType

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

typedef NeuronType::ValueType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::ValueType

Definition at line 80 of file otbSOM.h.

Constructor & Destructor Documentation

◆ SOM() [1/2]

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >

otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SOM

protected

Constructor

Definition at line 38 of file otbSOM.hxx.

◆ ~SOM()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >

otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::~SOM

overrideprotected

Destructor

Definition at line 58 of file otbSOM.hxx.

◆ SOM() [2/2]

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

otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SOM ( const Self & )

privatedelete

Size of the neurons map

Member Function Documentation

◆ AllocateOutputs()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >

void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::AllocateOutputs

overrideprotected

Output allocation redefinition

Output redefinition

Definition at line 162 of file otbSOM.hxx.

◆ CreateAnother()

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

virtual::itk::LightObject::Pointer otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::CreateAnother ( void ) const

◆ GenerateData()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >

void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GenerateData ( void )

overrideprotected

Main computation method

Definition at line 176 of file otbSOM.hxx.

◆ GenerateOutputInformation()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >

void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GenerateOutputInformation

overrideprotected

Output information redefinition

Definition at line 144 of file otbSOM.hxx.

◆ GetBetaEnd()

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

virtual double otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetBetaEnd ( )

virtual

Size of the neurons map

◆ GetBetaInit()

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

virtual double otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetBetaInit ( )

virtual

Size of the neurons map

◆ GetMapSize()

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

virtual SizeType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetMapSize ( )

virtual

Size of the neurons map

◆ GetMaxWeight()

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

virtual ValueType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetMaxWeight ( )

virtual

Size of the neurons map

◆ GetMinWeight()

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

virtual ValueType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetMinWeight ( )

virtual

Size of the neurons map

◆ GetNameOfClass()

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

virtual const char* otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetNameOfClass ( ) const

virtual

Runtime information macro

Reimplemented in otb::PeriodicSOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >.

◆ GetNeighborhoodSizeInit()

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

virtual SizeType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetNeighborhoodSizeInit ( )

virtual

Size of the neurons map

◆ GetNumberOfIterations()

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

virtual unsigned int otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetNumberOfIterations ( )

virtual

Size of the neurons map

◆ GetRandomInit()

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

virtual bool otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetRandomInit ( )

virtual

Size of the neurons map

◆ GetSeed()

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

virtual unsigned int otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetSeed ( )

virtual

Size of the neurons map

◆ itkGetObjectMacro()

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

otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::itkGetObjectMacro	(	ListSample	,
		ListSampleType
	)

Size of the neurons map

◆ New()

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

static Pointer otb::SOM< 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::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::operator= ( const Self & )

privatedelete

Size of the neurons map

◆ PrintSelf()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >

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

overrideprotected

PrintSelf method

Definition at line 225 of file otbSOM.hxx.

◆ SetBetaEnd()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetBetaEnd ( double _arg )

virtual

Size of the neurons map

◆ SetBetaFunctor()

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

void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetBetaFunctor ( const SOMLearningBehaviorFunctorType & functor )

inline

Size of the neurons map

Definition at line 115 of file otbSOM.h.

◆ SetBetaInit()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetBetaInit ( double _arg )

virtual

Size of the neurons map

◆ SetListSample()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetListSample ( ListSampleType * _arg )

virtual

Size of the neurons map

◆ SetMapSize()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetMapSize ( SizeType _arg )

virtual

Size of the neurons map

◆ SetMaxWeight()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetMaxWeight ( ValueType _arg )

virtual

Size of the neurons map

◆ SetMinWeight()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetMinWeight ( ValueType _arg )

virtual

Size of the neurons map

◆ SetNeighborhoodSizeFunctor()

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

void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetNeighborhoodSizeFunctor ( const SOMNeighborhoodBehaviorFunctorType & functor )

inline

Size of the neurons map

Definition at line 120 of file otbSOM.h.

◆ SetNeighborhoodSizeInit()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetNeighborhoodSizeInit ( SizeType _arg )

virtual

Size of the neurons map

◆ SetNumberOfIterations()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetNumberOfIterations ( unsigned int _arg )

virtual

Accessors

◆ SetRandomInit()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetRandomInit ( bool _arg )

virtual

Size of the neurons map

◆ SetSeed()

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

virtual void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SetSeed ( unsigned int _arg )

virtual

Size of the neurons map

◆ Step()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >

void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Step ( unsigned int currentIteration )

protectedvirtual

Step one iteration.

Reimplemented in otb::PeriodicSOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >, otb::PeriodicSOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >, and otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >.

Definition at line 125 of file otbSOM.hxx.

◆ UpdateMap()

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >

void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::UpdateMap	(	const NeuronType &	sample,
		double	beta,
		SizeType &	radius
	)

protectedvirtual

Update the output map with a new sample.

Parameters

sample	The new sample to learn,
beta	The learning coefficient,
radius	The radius of the nieghbourhood.

Reimplemented in otb::PeriodicSOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >, otb::PeriodicSOM< TListSample, TMap, Functor::CzihoSOMLearningBehaviorFunctor, Functor::CzihoSOMNeighborhoodBehaviorFunctor >, and otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >.

Definition at line 69 of file otbSOM.hxx.

Member Data Documentation

◆ m_BetaEnd

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

double otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_BetaEnd

private

Final learning coefficient

Definition at line 170 of file otbSOM.h.

◆ m_BetaFunctor

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

SOMLearningBehaviorFunctorType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_BetaFunctor

private

Behavior of the Learning weightening (link to the beta coefficient)

Definition at line 191 of file otbSOM.h.

◆ m_BetaInit

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

double otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_BetaInit

private

Initial learning coefficient

Definition at line 167 of file otbSOM.h.

◆ m_ListSample

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

ListSamplePointerType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_ListSample

private

The input list sample

Definition at line 188 of file otbSOM.h.

◆ m_MapSize

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

SizeType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_MapSize

private

Size of the neurons map

Definition at line 161 of file otbSOM.h.

◆ m_MaxWeight

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

ValueType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_MaxWeight

private

Maximum initial neuron weights

Definition at line 179 of file otbSOM.h.

◆ m_MinWeight

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

ValueType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_MinWeight

private

Minimum initial neuron weights

Definition at line 176 of file otbSOM.h.

◆ m_NeighborhoodSizeFunctor

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

SOMNeighborhoodBehaviorFunctorType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_NeighborhoodSizeFunctor

private

Behavior of the Neighborhood extent

Definition at line 194 of file otbSOM.h.

◆ m_NeighborhoodSizeInit

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

SizeType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_NeighborhoodSizeInit

private

Initial neighborhood size

Definition at line 173 of file otbSOM.h.

◆ m_NumberOfIterations

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

unsigned int otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_NumberOfIterations

private

Number of iterations

Definition at line 164 of file otbSOM.h.

◆ m_RandomInit

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

bool otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_RandomInit

private

Random initialization bool

Definition at line 182 of file otbSOM.h.

◆ m_Seed

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

unsigned int otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::m_Seed

private

Seed for random initialization

Definition at line 185 of file otbSOM.h.

◆ MapDimension

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

const unsigned int otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::MapDimension = MapType::ImageDimension

static

Map dimension

Definition at line 90 of file otbSOM.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ ListSamplePointerType

◆ ListSampleType

◆ MapPointerType

◆ MapType

◆ NeuronType

◆ Pointer

◆ RegionType

◆ Self

◆ SizeType

◆ SOMLearningBehaviorFunctorType

◆ SOMNeighborhoodBehaviorFunctorType

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ SOM() [1/2]

◆ ~SOM()

◆ SOM() [2/2]

Member Function Documentation

◆ AllocateOutputs()

◆ CreateAnother()

◆ GenerateData()

◆ GenerateOutputInformation()

◆ GetBetaEnd()

◆ GetBetaInit()

◆ GetMapSize()

◆ GetMaxWeight()

◆ GetMinWeight()

◆ GetNameOfClass()

◆ GetNeighborhoodSizeInit()

◆ GetNumberOfIterations()

◆ GetRandomInit()

◆ GetSeed()

◆ itkGetObjectMacro()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ SetBetaEnd()

◆ SetBetaFunctor()

◆ SetBetaInit()

◆ SetListSample()

◆ SetMapSize()

◆ SetMaxWeight()

◆ SetMinWeight()

◆ SetNeighborhoodSizeFunctor()

◆ SetNeighborhoodSizeInit()

◆ SetNumberOfIterations()

◆ SetRandomInit()

◆ SetSeed()

◆ Step()

◆ UpdateMap()

Member Data Documentation

◆ m_BetaEnd

◆ m_BetaFunctor

◆ m_BetaInit

◆ m_ListSample

◆ m_MapSize

◆ m_MaxWeight

◆ m_MinWeight

◆ m_NeighborhoodSizeFunctor

◆ m_NeighborhoodSizeInit

◆ m_NumberOfIterations

◆ m_RandomInit

◆ m_Seed

◆ MapDimension