otbSOMbasedImageFilter.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 otbSOMbasedImageFilter_h
#define otbSOMbasedImageFilter_h
 
#include "itkMacro.h"
#include "itkUnaryFunctorImageFilter.h"
 
namespace otb
{
 
namespace Functor
{
 
template <class TInput, class TOutput, class TDistanceMetric, class TMap>
class ITK_EXPORT SOMbasedImageFilterFunctor
{
public:
  typedef SOMbasedImageFilterFunctor  Self;
  typedef TMap                        MapType;
  typedef typename MapType::Pointer   MapPointerType;
  typedef typename MapType::IndexType IndexType;
  typedef typename MapType::PixelType NeuronType;
 
  typedef TDistanceMetric                DistanceType;
  typedef typename DistanceType::Pointer DistancePointerType;
 
  SOMbasedImageFilterFunctor()
  {
  }
  virtual ~SOMbasedImageFilterFunctor()
  {
  }
 
  TOutput operator()(const TInput& input);
 
  MapType* GetMap() const
  {
    return this->m_Map;
  }
  void SetMap(const MapType* theMap);
 
  DistanceType* GetDistance()
  {
    return this->m_Distance;
  }
 
protected:
  IndexType GetWinner(const NeuronType& sample);
 
  MapPointerType      m_Map;
  DistancePointerType m_Distance;
 
private:
  SOMbasedImageFilterFunctor(const Self&); // not implemented
  void operator=(const Self&);             // not implemented
};
 
} // end of namespace Functor
 
template <class TInputImage, class TOutputImage, class TDistanceMetric, class TMap>
class ITK_EXPORT SOMbasedImageFilter
    : public itk::UnaryFunctorImageFilter<
          TInputImage, TOutputImage,
          Functor::SOMbasedImageFilterFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType, TDistanceMetric, TMap>>
{
public:
  typedef SOMbasedImageFilter Self;
  typedef typename itk::UnaryFunctorImageFilter<
      TInputImage, TOutputImage, Functor::SOMbasedImageFilterFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType, TDistanceMetric, TMap>>
                                        Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(SOMbasedImageFilter, UnaryFunctorImageFilter);
 
  typedef TDistanceMetric                      DistanceMetricType;
  typedef typename DistanceMetricType::Pointer DistanceMetricPointerType;
 
  typedef TMap                      MapType;
  typedef typename MapType::Pointer MapPointerType;
 
  typedef Functor::SOMbasedImageFilterFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType, TDistanceMetric, TMap> FunctorType;
 
  typedef typename TInputImage::PixelType MeasurementType;
 
  void SetMap(const MapType* theMap);
 
protected:
  // throw the Map to the functor
  void BeforeThreadedGenerateData(void) override;
 
  SOMbasedImageFilter();
  ~SOMbasedImageFilter() override
  {
  }
 
private:
  SOMbasedImageFilter(const Self&);
  void operator=(const Self&) = delete;
 
  MapPointerType m_Map;
 
}; // end of class SOMbasedImageFilter
 
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSOMbasedImageFilter.hxx"
#endif
 
#endif