otbPeriodicSOM.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2022 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 otbPeriodicSOM_h
#define otbPeriodicSOM_h
 
#include "otbSOM.h"
 
namespace otb
{
 
template <class TListSample, class TMap, class TSOMLearningBehaviorFunctor = Functor::CzihoSOMLearningBehaviorFunctor,
          class TSOMNeighborhoodBehaviorFunctor = Functor::CzihoSOMNeighborhoodBehaviorFunctor>
class ITK_EXPORT PeriodicSOM : public SOM<TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor>
{
public:
 
  typedef PeriodicSOM Self;
  typedef SOM<TListSample, TMap, TSOMLearningBehaviorFunctor, TSOMNeighborhoodBehaviorFunctor> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PeriodicSOM, SOM);
 
  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;
 
protected:
  PeriodicSOM()
  {
  }
 
  ~PeriodicSOM() override
  {
  }
 
  void GenerateOutputInformation() override
  {
    Superclass::GenerateOutputInformation();
  }
 
  void AllocateOutputs() override
  {
    Superclass::AllocateOutputs();
  }
 
  void GenerateData(void) override
  {
    Superclass::GenerateData();
  }
 
  void UpdateMap(const NeuronType& sample, double beta, SizeType& radius) override;
 
  void Step(unsigned int currentIteration) override
  {
    Superclass::Step(currentIteration);
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
  }
 
private:
  PeriodicSOM(const Self&) = delete;
  void operator=(const Self&) = delete;
 
}; // end of class
 
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbPeriodicSOM.hxx"
#endif
 
#endif