otbSarRadiometricCalibrationFunctor.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt for details.


     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#ifndef __otbSarRadiometricCalibrationFunctor_h
#define __otbSarRadiometricCalibrationFunctor_h

#include "otbMath.h"
#include "itkNumericTraits.h"

namespace otb
{

namespace Functor
{
template<class TInput, class TOutput>
class ITK_EXPORT SarRadiometricCalibrationFunctor
{
public:
  typedef TInput                                            InputType;
  typedef TOutput                                           OutputType;
  typedef typename itk::NumericTraits<InputType>::AbsType   RealType;

  SarRadiometricCalibrationFunctor()
  {
    m_Noise = 0.0;
    m_Scale = 1.0;
    m_IncidenceAngle = CONST_PI_2;
    m_AntennaPatternOldGain = 1.0;
    m_AntennaPatternNewGain = 1.0;
    m_RangeSpreadLoss = 1.0;
  };

  ~SarRadiometricCalibrationFunctor(){};

  inline TOutput operator ()(const TInput& value) const
  {
    RealType digitalNumber = static_cast<RealType> (vcl_abs(value));
    RealType sigma;

    sigma  = m_Scale * (digitalNumber * digitalNumber - m_Noise);
    sigma *= vcl_sin(m_IncidenceAngle);
    sigma *= m_AntennaPatternOldGain;
    sigma /= m_AntennaPatternNewGain;
    sigma *= m_RangeSpreadLoss;

    if(sigma < 0.0)
    {
      sigma = 0.0;
    }

    return static_cast<OutputType>(sigma);
  }

  void SetNoise(RealType value)
  {
    m_Noise = value;
  }

  RealType GetNoise() const
  {
    return m_Noise;
  }

  void SetScale(RealType value)
  {
    m_Scale = value;
  }

  RealType GetScale() const
  {
    return m_Scale;
  }

  void SetAntennaPatternNewGain(RealType value)
  {
    m_AntennaPatternNewGain = value;
  }

  RealType GetAntennaPatternNewGain() const
  {
    return m_AntennaPatternNewGain;
  }

  void SetAntennaPatternOldGain(RealType value)
  {
    m_AntennaPatternOldGain = value;
  }

  RealType GetAntennaPatternOldGain() const
  {
    return m_AntennaPatternOldGain;
  }
  
  void SetIncidenceAngle(RealType value)
  {
    m_IncidenceAngle = value;
  }

  RealType GetIncidenceAngle() const
  {
    return m_IncidenceAngle;
  }

  void SetRangeSpreadLoss(RealType value)
  {
    m_RangeSpreadLoss = value;
  }

  RealType GetRangeSpreadLoss() const
  {
    return m_RangeSpreadLoss;
  }

private:
  RealType   m_Noise;
  RealType   m_Scale;
  RealType   m_AntennaPatternNewGain;
  RealType   m_AntennaPatternOldGain;
  RealType   m_IncidenceAngle;
  RealType   m_RangeSpreadLoss;
};
}

}

#endif