otbSOM.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 * Copyright (C) 2007-2012 Institut Mines Telecom / Telecom Bretagne
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbSOM_h
#define otbSOM_h
 
#include "itkImageToImageFilter.h"
#include "itkEuclideanDistanceMetric.h"
 
#include "otbCzihoSOMLearningBehaviorFunctor.h"
#include "otbCzihoSOMNeighborhoodBehaviorFunctor.h"
 
namespace otb
{
template <class TListSample, class TMap, class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor,
          class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
class ITK_EXPORT SOM : public itk::ImageSource<TMap>
{
public:
 
  typedef SOM                           Self;
  typedef itk::ImageSource<TMap>        Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(SOM, ImageSource);
 
  typedef TListSample                      ListSampleType;
  typedef typename ListSampleType::Pointer ListSamplePointerType;
  typedef TMap                             MapType;
  typedef typename MapType::PixelType      NeuronType;
  typedef typename NeuronType::ValueType   ValueType;
  typedef typename MapType::IndexType      IndexType;
  typedef typename MapType::SizeType       SizeType;
  typedef typename MapType::RegionType     RegionType;
  typedef typename MapType::Pointer        MapPointerType;
 
  typedef TSOMLearningBehaviorFunctor     SOMLearningBehaviorFunctorType;
  typedef TSOMNeighborhoodBehaviorFunctor SOMNeighborhoodBehaviorFunctorType;
 
  itkStaticConstMacro(MapDimension, unsigned int, MapType::ImageDimension);
 
  itkSetMacro(NumberOfIterations, unsigned int);
  itkGetMacro(NumberOfIterations, unsigned int);
  itkSetMacro(BetaInit, double);
  itkGetMacro(BetaInit, double);
  itkSetMacro(BetaEnd, double);
  itkGetMacro(BetaEnd, double);
  itkSetMacro(MinWeight, ValueType);
  itkGetMacro(MinWeight, ValueType);
  itkSetMacro(MaxWeight, ValueType);
  itkGetMacro(MaxWeight, ValueType);
  itkSetMacro(MapSize, SizeType);
  itkGetMacro(MapSize, SizeType);
  itkSetMacro(NeighborhoodSizeInit, SizeType);
  itkGetMacro(NeighborhoodSizeInit, SizeType);
  itkSetMacro(RandomInit, bool);
  itkGetMacro(RandomInit, bool);
  itkSetMacro(Seed, unsigned int);
  itkGetMacro(Seed, unsigned int);
  itkGetObjectMacro(ListSample, ListSampleType);
  itkSetObjectMacro(ListSample, ListSampleType);
 
  void SetBetaFunctor(const SOMLearningBehaviorFunctorType& functor)
  {
    m_BetaFunctor = functor;
  }
 
  void SetNeighborhoodSizeFunctor(const SOMNeighborhoodBehaviorFunctorType& functor)
  {
    m_NeighborhoodSizeFunctor = functor;
  }
 
protected:
  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;
 
private:
  SOM(const Self&) = delete;
  void operator=(const Self&) = delete;
  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;
};
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSOM.hxx"
#endif
 
#endif