otbSarBrightnessFunction.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 otbSarBrightnessFunction_h
#define otbSarBrightnessFunction_h
 
#include "otbSarBrightnessFunctor.h"
#include "otbSarParametricMapFunction.h"
 
 
namespace otb
{
 
template <class TInputImage, class TCoordRep = float>
class ITK_EXPORT SarBrightnessFunction
    : public itk::ImageFunction<TInputImage, typename itk::NumericTraits<typename TInputImage::PixelType>::AbsType, TCoordRep>
{
public:
  typedef SarBrightnessFunction Self;
  typedef itk::ImageFunction<TInputImage, typename itk::NumericTraits<typename TInputImage::PixelType>::AbsType, TCoordRep> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(SarBrightnessFunction, itk::ImageFunction);
 
  itkNewMacro(Self);
 
  typedef TInputImage                              InputImageType;
  typedef typename InputImageType::PixelType       InputPixelType;
  typedef typename Superclass::OutputType          OutputType;
  typedef typename Superclass::IndexType           IndexType;
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
  typedef typename Superclass::PointType           PointType;
 
  itkStaticConstMacro(ImageDimension, unsigned int, InputImageType::ImageDimension);
 
 
  typedef double RealType;
  typedef otb::Functor::SarBrightnessFunctor<RealType, RealType> FunctorType;
  typedef typename FunctorType::RealType FunctorRealType;
 
  typedef otb::SarParametricMapFunction<InputImageType> ParametricFunctionType;
  typedef typename ParametricFunctionType::Pointer      ParametricFunctionPointer;
  typedef typename ParametricFunctionType::ConstPointer ParametricFunctionConstPointer;
 
  OutputType EvaluateAtIndex(const IndexType& index) const override;
 
  OutputType Evaluate(const PointType& point) const override
  {
    IndexType index;
    this->ConvertPointToNearestIndex(point, index);
    return this->EvaluateAtIndex(index);
  }
  OutputType EvaluateAtContinuousIndex(const ContinuousIndexType& cindex) const override
  {
    IndexType index;
    this->ConvertContinuousIndexToNearestIndex(cindex, index);
    return this->EvaluateAtIndex(index);
  }
 
  void SetInputImage(const InputImageType* ptr) override;
 
 
  itkSetMacro(Scale, FunctorRealType);
  itkGetMacro(Scale, FunctorRealType);
 
  itkSetObjectMacro(Noise, ParametricFunctionType);
  itkGetConstObjectMacro(Noise, ParametricFunctionType);
  itkGetObjectMacro(Noise, ParametricFunctionType);
 
  itkSetMacro(EnableNoise, bool);
  itkGetMacro(EnableNoise, bool);
 
  itkSetObjectMacro(AntennaPatternNewGain, ParametricFunctionType);
  itkGetConstObjectMacro(AntennaPatternNewGain, ParametricFunctionType);
  itkGetObjectMacro(AntennaPatternNewGain, ParametricFunctionType);
 
  itkSetObjectMacro(AntennaPatternOldGain, ParametricFunctionType);
  itkGetObjectMacro(AntennaPatternOldGain, ParametricFunctionType);
  itkGetConstObjectMacro(AntennaPatternOldGain, ParametricFunctionType);
 
  itkSetObjectMacro(RangeSpreadLoss, ParametricFunctionType);
  itkGetConstObjectMacro(RangeSpreadLoss, ParametricFunctionType);
  itkGetObjectMacro(RangeSpreadLoss, ParametricFunctionType);
 
 
protected:
  SarBrightnessFunction();
  ~SarBrightnessFunction() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  SarBrightnessFunction(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  FunctorRealType           m_Scale;
  ParametricFunctionPointer m_Noise;
  bool                      m_EnableNoise;
  ParametricFunctionPointer m_AntennaPatternNewGain;
  ParametricFunctionPointer m_AntennaPatternOldGain;
  ParametricFunctionPointer m_RangeSpreadLoss;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSarBrightnessFunction.hxx"
#endif
 
#endif