otbMultiChannelsPolarimetricSynthesisFilter.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 otbMultiChannelsPolarimetricSynthesisFilter_h
#define otbMultiChannelsPolarimetricSynthesisFilter_h
 
#include "itkInPlaceImageFilter.h"
#include "otbPolarimetricSynthesisFunctor.h"
#include "otbPolarimetricData.h"
#include <complex>
 
namespace otb
{
 
template <class TInputImage, class TOutputImage,
          class TFunction = Functor::PolarimetricSynthesisFunctor<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType,
                                                                  typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType,
                                                                  typename TOutputImage::PixelType>>
class ITK_EXPORT MultiChannelsPolarimetricSynthesisFilter : public itk::InPlaceImageFilter<TInputImage, TOutputImage>
{
public:
  typedef MultiChannelsPolarimetricSynthesisFilter Self;
  typedef itk::InPlaceImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(MultiChannelsPolarimetricSynthesisFilter, InPlaceImageFilter);
 
  typedef std::complex<double>                  InputPixelType;
  typedef TFunction                             FunctorType;
  typedef TInputImage                           InputImageType;
  typedef typename InputImageType::ConstPointer InputImagePointer;
  typedef typename InputImageType::RegionType   InputImageRegionType;
  typedef typename InputImageType::PixelType    InputImagePixelType;
  typedef TOutputImage                          OutputImageType;
  typedef typename OutputImageType::Pointer     OutputImagePointer;
  typedef typename OutputImageType::RegionType  OutputImageRegionType;
  typedef typename OutputImageType::PixelType   OutputImagePixelType;
  typedef typename std::complex<double>         ComplexType;
  typedef typename itk::FixedArray<ComplexType, 2> ComplexArrayType;
  typedef typename itk::FixedArray<int, 4>         IndexArrayType;
 
  FunctorType& GetFunctor()
  {
    return m_Functor;
  }
  const FunctorType& GetFunctor() const
  {
    return m_Functor;
  }
 
  void SetFunctor(const FunctorType& functor)
  {
    if (m_Functor != functor)
    {
      m_Functor = functor;
      this->Modified();
    }
  }
 
  void SetEi(ComplexArrayType ei)
  {
    m_Ei = ei;
    this->GetFunctor().SetEi(ei);
    this->Modified();
  }
 
  void SetEr(ComplexArrayType er)
  {
    m_Er = er;
    this->GetFunctor().SetEr(er);
    this->Modified();
  }
 
  itkSetMacro(PsiI, double);
  itkGetMacro(PsiI, double);
 
  itkSetMacro(KhiI, double);
  itkGetMacro(KhiI, double);
 
  itkSetMacro(PsiR, double);
  itkGetMacro(PsiR, double);
 
  itkSetMacro(KhiR, double);
  itkGetMacro(KhiR, double);
 
  itkSetMacro(EmissionH, bool);
  itkGetMacro(EmissionH, bool);
 
  itkSetMacro(EmissionV, bool);
  itkGetMacro(EmissionV, bool);
 
  itkSetMacro(Mode, int);
  itkGetMacro(Mode, int);
 
  itkSetMacro(Gain, double);
  itkGetMacro(Gain, double);
 
  void ForceCoPolar();
 
  void ForceCrossPolar();
 
protected:
  MultiChannelsPolarimetricSynthesisFilter();
 
  ~MultiChannelsPolarimetricSynthesisFilter() override
  {
  }
 
  void GenerateOutputInformation() override;
 
  void BeforeThreadedGenerateData() override;
 
  void DynamicThreadedGenerateData(const OutputImageRegionType& outputRegionForThread) override;
 
  void ComputeElectromagneticFields();
 
  void VerifyAndForceInputs();
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  MultiChannelsPolarimetricSynthesisFilter(const Self&) = delete;
 
  double m_PsiI;
 
  double m_KhiI;
 
  double m_PsiR;
 
  double m_KhiR;
 
  double m_Gain;
 
  int m_Mode;
 
  ComplexArrayType m_Ei;
 
  ComplexArrayType m_Er;
 
  PolarimetricData::Pointer m_ArchitectureType;
 
  FunctorType m_Functor;
 
  bool m_EmissionH;
  bool m_EmissionV;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbMultiChannelsPolarimetricSynthesisFilter.hxx"
#endif
 
#endif