otbSinclairToCircularCovarianceMatrixImageFilter.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 otbSinclairToCircularCovarianceMatrixImageFilter_h
#define otbSinclairToCircularCovarianceMatrixImageFilter_h
 
#include <complex>
 
#include "otbSinclairToCovarianceMatrixImageFilter.h"
#include "otbFunctorImageFilter.h"
#include "otbPolarimetryTags.h"
 
namespace otb
{
namespace Functor
{
template <class TInput1, class TInput2, class TInput3, class TInput4, class TOutput>
class SinclairToCircularCovarianceMatrixFunctor
{
public:
  typedef double                      RealType;
  typedef std::complex<RealType>      ComplexType;
  typedef typename TOutput::ValueType OutputValueType;
  typedef SinclairToCovarianceMatrixFunctor<ComplexType, ComplexType, ComplexType, ComplexType, TOutput> SinclairToCovarianceFunctorType;
  inline void operator()(TOutput& result, const TInput1& Shh, const TInput2& Shv, const TInput3& Svh, const TInput4& Svv) const
  {
    const ComplexType S_hh = static_cast<ComplexType>(Shh);
    const ComplexType S_hv = static_cast<ComplexType>(Shv);
    const ComplexType S_vh = static_cast<ComplexType>(Svh);
    const ComplexType S_vv = static_cast<ComplexType>(Svv);
 
    const ComplexType jS_hv = S_hv * ComplexType(0., 1.);
    const ComplexType jS_vh = S_vh * ComplexType(0., 1.);
    const ComplexType jS_hh = S_hh * ComplexType(0., 1.);
    const ComplexType jS_vv = S_vv * ComplexType(0., 1.);
 
    const ComplexType coef(0.5);
 
    const ComplexType Sll = coef * (S_hh + jS_hv + jS_vh - S_vv);
    const ComplexType Slr = coef * (jS_hh + S_hv - S_vh + jS_vv);
    const ComplexType Srl = coef * (jS_hh - S_hv + S_vh + jS_vv);
    const ComplexType Srr = coef * (-S_hh + jS_hv + jS_vh + S_vv);
 
    SinclairToCovarianceFunctorType funct;
    funct(result, Sll, Slr, Srl, Srr);
  }
 
  constexpr size_t OutputSize(...) const
  {
    // Size of circular covariance matrix
    return 10;
  }
 
  SinclairToCircularCovarianceMatrixFunctor()
  {
  }
 
  virtual ~SinclairToCircularCovarianceMatrixFunctor()
  {
  }
};
 
} // namespace Functor
 
template <typename TInputImage, typename TOutputImage>
using SinclairToCircularCovarianceMatrixImageFilter = FunctorImageFilter<
    Functor::SinclairToCircularCovarianceMatrixFunctor<typename TInputImage::PixelType, typename TInputImage::PixelType, typename TInputImage::PixelType,
                                                       typename TInputImage::PixelType, typename TOutputImage::PixelType>,
    std::tuple<polarimetry_tags::hh, polarimetry_tags::hv, polarimetry_tags::vh, polarimetry_tags::vv>>;
} // namespace otb
 
#endif