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

#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< SelfPointer
 
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 Types inherited from itk::ImageSource< TMap >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TMap OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject 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

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void SetBetaFunctor (const SOMLearningBehaviorFunctorType &functor)
 
void SetNeighborhoodSizeFunctor (const SOMNeighborhoodBehaviorFunctorType &functor)
 
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)
 
- Public Member Functions inherited from itk::ImageSource< TMap >
OutputImageTypeGetOutput (unsigned int idx)
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput ()
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- 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
 

Static Public Member Functions

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 ()
 

Static Public Attributes

static const unsigned int MapDimension = MapType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TMap >
static const unsigned int OutputImageDimension
 

Protected Member Functions

 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
 
- Protected Member Functions inherited from itk::ImageSource< TMap >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- 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

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

Private Attributes

double m_BetaEnd
 
SOMLearningBehaviorFunctorType m_BetaFunctor
 
double m_BetaInit
 
ListSamplePointerType m_ListSample
 
SizeType m_MapSize
 
ValueType m_MaxWeight
 
ValueType m_MinWeight
 
SOMNeighborhoodBehaviorFunctorType m_NeighborhoodSizeFunctor
 
SizeType m_NeighborhoodSizeInit
 
unsigned int m_NumberOfIterations
 
bool m_RandomInit
 
unsigned int m_Seed
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ImageSource< TMap >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

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

.

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 61 of file otbSOM.h.

Member Typedef Documentation

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 70 of file otbSOM.h.

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 83 of file otbSOM.h.

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 79 of file otbSOM.h.

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 76 of file otbSOM.h.

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 86 of file otbSOM.h.

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 80 of file otbSOM.h.

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 81 of file otbSOM.h.

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 69 of file otbSOM.h.

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 85 of file otbSOM.h.

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 67 of file otbSOM.h.

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 84 of file otbSOM.h.

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 88 of file otbSOM.h.

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 89 of file otbSOM.h.

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 68 of file otbSOM.h.

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 82 of file otbSOM.h.

Constructor & Destructor Documentation

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::SOM ( )
protected

Constructor

Definition at line 41 of file otbSOM.hxx.

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::~SOM ( )
overrideprotected

Destructor

Definition at line 64 of file otbSOM.hxx.

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

Member Function Documentation

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::AllocateOutputs ( void  )
overrideprotectedvirtual

Output allocation redefinition

Output redefinition

Reimplemented from itk::ImageSource< TMap >.

Reimplemented in otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >.

Definition at line 194 of file otbSOM.hxx.

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
virtual
template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GenerateData ( void  )
overrideprotectedvirtual
template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GenerateOutputInformation ( void  )
overrideprotectedvirtual

Output information redefinition

Reimplemented from itk::ProcessObject.

Reimplemented in otb::SOMWithMissingValue< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >.

Definition at line 170 of file otbSOM.hxx.

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual double otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetBetaEnd ( )
virtual

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual double otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetBetaInit ( )
virtual

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual SizeType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetMapSize ( )
virtual

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual ValueType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetMaxWeight ( )
virtual

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual ValueType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetMinWeight ( )
virtual

Accessors

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
template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual SizeType otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetNeighborhoodSizeInit ( )
virtual

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual unsigned int otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetNumberOfIterations ( )
virtual

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual bool otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetRandomInit ( )
virtual

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
virtual unsigned int otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::GetSeed ( )
virtual

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::itkGetObjectMacro ( ListSample  ,
ListSampleType   
)

Accessors

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

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor, class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::operator= ( const Self )
privatedelete
template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual
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

Accessors

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

Definition at line 117 of file otbSOM.h.

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

Accessors

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

Accessors

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

Accessors

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

Accessors

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

Accessors

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

Definition at line 122 of file otbSOM.h.

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

Accessors

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

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

Accessors

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

Accessors

template<class TListSample , class TMap , class TSOMLearningBehaviorFunctor , class TSOMNeighborhoodBehaviorFunctor >
void otb::SOM< TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor >::Step ( unsigned int  currentIteration)
protectedvirtual
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
sampleThe new sample to learn,
betaThe learning coefficient,
radiusThe radius of the nieghbourhood.

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

Definition at line 79 of file otbSOM.hxx.

Member Data Documentation

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 172 of file otbSOM.h.

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 193 of file otbSOM.h.

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 169 of file otbSOM.h.

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 190 of file otbSOM.h.

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 163 of file otbSOM.h.

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 181 of file otbSOM.h.

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 178 of file otbSOM.h.

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 196 of file otbSOM.h.

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 175 of file otbSOM.h.

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 166 of file otbSOM.h.

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 184 of file otbSOM.h.

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 187 of file otbSOM.h.

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 92 of file otbSOM.h.


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