otbSarParametricMapFunction.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * 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 otbSarParametricMapFunction_h
#define otbSarParametricMapFunction_h
 
#include "itkImageFunction.h"
#include "itkPointSet.h"
#include "itkVariableSizeMatrix.h"
 
namespace otb
{
 
template <class TInputImage, class TCoordRep = float>
class ITK_EXPORT SarParametricMapFunction
    : public itk::ImageFunction<TInputImage, typename itk::NumericTraits<typename TInputImage::PixelType>::ScalarRealType, TCoordRep>
{
public:
  typedef SarParametricMapFunction Self;
  typedef itk::ImageFunction<TInputImage, typename itk::NumericTraits<typename TInputImage::PixelType>::ScalarRealType, TCoordRep> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(SarParametricMapFunction, itk::ImageFunction);
 
  itkNewMacro(Self);
 
  typedef TInputImage                              InputImageType;
  typedef typename InputImageType::PixelType       InputPixelType;
  typedef typename Superclass::OutputType          OutputType;
  typedef typename Superclass::IndexType           IndexType;
  typedef typename std::array<int, 2>              ArrayIndexType;
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
 
  itkStaticConstMacro(ImageDimension, unsigned int, InputImageType::ImageDimension);
 
  typedef itk::PointSet<OutputType, ImageDimension> PointSetType;
  typedef typename PointSetType::Pointer      PointSetPointer;
  typedef typename PointSetType::ConstPointer PointSetConstPointer;
  typedef typename PointSetType::PointType    PointType;
  typedef typename PointSetType::PixelType    PixelType;
 
  typedef itk::VariableSizeMatrix<double> MatrixType;
 
  typedef typename itk::NumericTraits<InputPixelType>::ScalarRealType RealType;
 
  RealType Evaluate(const PointType& point) const override;
 
  RealType EvaluateAtIndex(const IndexType& index) const override
  {
    PointType point;
    point[0] = static_cast<typename PointType::ValueType>(index[0]);
    point[1] = static_cast<typename PointType::ValueType>(index[1]);
    return this->Evaluate(point);
  }
 
  RealType EvaluateAtContinuousIndex(const ContinuousIndexType& cindex) const override
  {
    IndexType index;
    this->ConvertContinuousIndexToNearestIndex(cindex, index);
    return this->EvaluateAtIndex(index);
  }
 
  itkGetObjectMacro(PointSet, PointSetType);
  itkGetConstObjectMacro(PointSet, PointSetType);
  void SetPointSet(PointSetPointer val)
  {
    m_IsInitialize = false;
    m_PointSet     = val;
    this->Modified();
  }
 
  itkSetMacro(Coeff, MatrixType);
  itkGetMacro(Coeff, MatrixType);
  itkGetConstMacro(Coeff, MatrixType);
 
  itkGetConstReferenceMacro(IsInitialize, bool);
 
  void SetPolynomalSize(const IndexType PolynomalSize);
  void SetPolynomalSize(const ArrayIndexType PolynomalSize);
 
  void EvaluateParametricCoefficient();
 
  void SetConstantValue(const RealType& value);
 
protected:
  SarParametricMapFunction();
  ~SarParametricMapFunction() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  SarParametricMapFunction(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  double Horner(PointType point) const;
 
  PointSetPointer m_PointSet;
  MatrixType      m_Coeff;
  bool            m_IsInitialize;
  double          m_ProductWidth;  
  double          m_ProductHeight; 
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSarParametricMapFunction.hxx"
#endif
 
#endif