otbVegetationIndicesFunctor.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 otbVegetationIndicesFunctor_h
#define otbVegetationIndicesFunctor_h
 
#include "otbMath.h"
#include "otbRadiometricIndex.h"
 
namespace otb
{
 
namespace Functor
{
template <class TInput, class TOutput>
class NDVI : public RadiometricIndex<TInput, TOutput>
{
public:
  NDVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    return static_cast<TOutput>(Compute(red, nir));
  }
 
  // This static compute will be used in indices derived from NDVI
  static double Compute(const double& red, const double& nir)
  {
    if (std::abs(nir + red) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return 0.;
    }
 
    return (nir - red) / (nir + red);
  }
};
 
template <class TInput, class TOutput>
class RVI : public RadiometricIndex<TInput, TOutput>
{
public:
  RVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    if (std::abs(red) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return static_cast<TOutput>(0.);
    }
    return (static_cast<TOutput>(nir / red));
  }
};
 
template <class TInput, class TOutput>
class PVI : public RadiometricIndex<TInput, TOutput>
{
public:
  PVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    return (static_cast<TOutput>((nir - A * red - B) * C));
  }
 
  static constexpr double A = 0.90893;
  static constexpr double B = 7.46216;
  static constexpr double C = 9.74;
};
 
template <class TInput, class TOutput>
class SAVI : public RadiometricIndex<TInput, TOutput>
{
public:
  SAVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    if (std::abs(nir + red + L) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return static_cast<TOutput>(0.);
    }
    return (static_cast<TOutput>(((nir - red) * (1 + L)) / (nir + red + L)));
  }
 
  static constexpr double L = 0.5;
};
 
template <class TInput, class TOutput>
class TSAVI : public RadiometricIndex<TInput, TOutput>
{
public:
  TSAVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    double denominator = A * nir + red + X * (1. + A * A);
 
    if (std::abs(denominator) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return static_cast<TOutput>(0.);
    }
    return (static_cast<TOutput>((A * (nir - A * red - S)) / denominator));
  }
 
  static constexpr double A = 0.7;
  static constexpr double S = 0.9;
 
  static constexpr double X = 0.08;
};
 
template <class TInput, class TOutput>
class WDVI : public RadiometricIndex<TInput, TOutput>
{
public:
  WDVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    return static_cast<TOutput>(Compute(red, nir));
  }
 
  static double Compute(const double& red, const double& nir)
  {
    return (nir - S * red);
  }
 
  static constexpr double S = 0.4;
};
 
template <class TInput, class TOutput>
class MSAVI : public RadiometricIndex<TInput, TOutput>
{
public:
  MSAVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    double ndvi = NDVI<TInput, TOutput>::Compute(red, nir);
    double wdvi = WDVI<TInput, TOutput>::Compute(red, nir);
 
    double L = 1 - 2 * S * ndvi * wdvi;
 
    double denominator = nir + red + L;
 
    if (std::abs(denominator) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return static_cast<TOutput>(0.);
    }
 
    return (static_cast<TOutput>(((nir - red) * (1 + L)) / denominator));
  }
 
private:
  static constexpr double S = 0.4;
};
 
template <class TInput, class TOutput>
class MSAVI2 : public RadiometricIndex<TInput, TOutput>
{
public:
  MSAVI2() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    double sqrt_value = (2 * nir + 1) * (2 * nir + 1) - 8 * (nir - red);
    if (sqrt_value < 0.)
    {
      return static_cast<TOutput>(0.);
    }
    return (static_cast<TOutput>((2 * nir + 1 - std::sqrt(sqrt_value)) / 2.));
  }
};
 
template <class TInput, class TOutput>
class GEMI : public RadiometricIndex<TInput, TOutput>
{
public:
  GEMI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    double nu;
    double num_nu;
    double denom_nu = nir + red + 0.5;
 
    if (std::abs(denom_nu) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      nu = 0;
    }
    else
    {
      num_nu = 2 * (nir * nir - red * red) + 1.5 * nir + 0.5 * red;
      nu     = num_nu / denom_nu;
    }
 
    double denom_GEMI = 1 - red;
    if (std::abs(denom_GEMI) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return static_cast<TOutput>(0.);
    }
    return (static_cast<TOutput>((nu * (1 - 0.25 * nu) - (red - 0.125)) / denom_GEMI));
  }
};
 
template <class TInput, class TOutput>
class AVI : public RadiometricIndex<TInput, TOutput>
{
public:
  AVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::GREEN, CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto green = this->Value(CommonBandNames::GREEN, input);
    auto red   = this->Value(CommonBandNames::RED, input);
    auto nir   = this->Value(CommonBandNames::NIR, input);
 
    constexpr double dfact1 = (LambdaNir - LambdaR) / LambdaR;
    constexpr double dfact2 = (LambdaR - LambdaG) / LambdaR;
    double           dterm1;
    double           dterm2;
    if (std::abs(nir - red) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      dterm1 = 0;
    }
    else
    {
      dterm1 = std::atan(dfact1 / (nir - red));
    }
 
    if (std::abs(green - red) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      dterm2 = 0;
    }
    else
    {
      dterm2 = std::atan(dfact2 / (green - red));
    }
 
    return static_cast<TOutput>(dterm1 + dterm2);
  }
 
  static constexpr double LambdaG = 560;
 
  static constexpr double LambdaR = 660;
 
  static constexpr double LambdaNir = 830;
};
 
template <class TInput, class TOutput>
class ARVI : public RadiometricIndex<TInput, TOutput>
{
public:
  ARVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::BLUE, CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto blue = this->Value(CommonBandNames::BLUE, input);
    auto red  = this->Value(CommonBandNames::RED, input);
    auto nir  = this->Value(CommonBandNames::NIR, input);
 
    double RHOrb       = red - Gamma * (blue - red);
    double denominator = nir + RHOrb;
    if (std::abs(denominator) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return static_cast<TOutput>(0.);
    }
    return (static_cast<TOutput>((nir - RHOrb) / denominator));
  }
 
  static constexpr double Gamma = 0.5;
};
 
template <class TInput, class TOutput>
class EVI : public RadiometricIndex<TInput, TOutput>
{
public:
  EVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::BLUE, CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto blue = this->Value(CommonBandNames::BLUE, input);
    auto red  = this->Value(CommonBandNames::RED, input);
    auto nir  = this->Value(CommonBandNames::NIR, input);
 
    double denominator = nir + C1 * red - C2 * blue + L;
    if (std::abs(denominator) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return (static_cast<TOutput>(0.));
    }
    return (static_cast<TOutput>(G * (nir - red) / denominator));
  }
 
  static constexpr double G = 2.5;
 
  static constexpr double C1 = 6.0;
 
  static constexpr double C2 = 7.5;
 
  static constexpr double L = 1.0;
};
 
template <class TInput, class TOutput>
class IPVI : public RadiometricIndex<TInput, TOutput>
{
public:
  IPVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    if (std::abs(nir + red) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return static_cast<TOutput>(0.);
    }
    else
    {
      return (static_cast<TOutput>(nir / (nir + red)));
    }
  }
};
 
template <class TInput, class TOutput>
class TNDVI : public RadiometricIndex<TInput, TOutput>
{
public:
  TNDVI() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    double val = NDVI<TInput, TOutput>::Compute(red, nir) + 0.5;
 
    if (val < 0)
    {
      return (static_cast<TOutput>(0));
    }
    else
    {
      return (static_cast<TOutput>(std::sqrt(val)));
    }
  }
};
 
template <class TInput, class TOutput>
class LAIFromNDVILogarithmic : public RadiometricIndex<TInput, TOutput>
{
public:
  LAIFromNDVILogarithmic()
    : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR}), m_NdviSoil(0.1), m_NdviInf(0.89), m_ExtinctionCoefficient(0.71)
  {
  }
 
  void SetNdviSoil(const double& val)
  {
    m_NdviSoil = val;
  }
 
  const double& GetNdviSoil() const
  {
    return m_NdviSoil;
  }
 
  void SetNdviInf(const double& val)
  {
    m_NdviInf = val;
  }
 
  const double& GetNdviInf() const
  {
    return m_NdviInf;
  }
 
  void SetExtinctionCoefficient(const double& val)
  {
    m_ExtinctionCoefficient = val;
  }
 
  const double& GetExtionctionCoefficient() const
  {
    return m_ExtinctionCoefficient;
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    double val = NDVI<TInput, TOutput>::Compute(red, nir);
 
    if (val < 0)
    {
      return (static_cast<TOutput>(0));
    }
    else
    {
      return static_cast<TOutput>(-(1.0 / m_ExtinctionCoefficient) * std::log((val - m_NdviInf) / (m_NdviSoil - m_NdviInf)));
    }
  }
 
  double m_NdviSoil;
  double m_NdviInf;
  double m_ExtinctionCoefficient;
};
 
 
template <class TInput, class TOutput>
class LAIFromReflectancesLinear : public RadiometricIndex<TInput, TOutput>
{
public:
  LAIFromReflectancesLinear() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR}), m_RedCoef(-17.91), m_NirCoef(12.26)
  {
  }
 
  void SetRedCoef(const double& val)
  {
    m_RedCoef = val;
  }
 
  const double& GetRedCoef() const
  {
    return m_RedCoef;
  }
 
  void SetNirCoef(const double& val)
  {
    m_NirCoef = val;
  }
 
  const double& GetNirCoef() const
  {
    return m_NirCoef;
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    return (static_cast<TOutput>(m_RedCoef * red + m_NirCoef * nir));
  }
 
  double m_RedCoef;
  double m_NirCoef;
};
 
 
template <class TInput, class TOutput>
class LAIFromNDVIFormosat2Functor : public RadiometricIndex<TInput, TOutput>
{
public:
  LAIFromNDVIFormosat2Functor() : RadiometricIndex<TInput, TOutput>({CommonBandNames::RED, CommonBandNames::NIR})
  {
  }
 
  TOutput operator()(const itk::VariableLengthVector<TInput>& input) const override
  {
    auto red = this->Value(CommonBandNames::RED, input);
    auto nir = this->Value(CommonBandNames::NIR, input);
 
    if (std::abs(nir + red) < RadiometricIndex<TInput, TOutput>::Epsilon)
    {
      return static_cast<TOutput>(0.);
    }
    return static_cast<TOutput>(A * (std::exp((nir - red) / (red + nir) * B) - std::exp(C * B)));
  }
 
  static constexpr double A = 0.1519;
  static constexpr double B = 3.9443;
  static constexpr double C = 0.13;
};
 
 
} // namespace Functor
} // namespace otb
 
#endif