otbPolarimetricSynthesisFilter.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 __otbPolarimetricSynthesisFilter_h
#define __otbPolarimetricSynthesisFilter_h

#include "otbQuaternaryFunctorImageFilter.h"
#include "otbPolarimetricSynthesisFunctor.h"
#include "otbPolarimetricData.h"
#include "itkFixedArray.h"
#include <complex>

namespace otb
{

template <class TInputImageHH, class TInputImageHV, class TInputImageVH, class TInputImageVV, class TOutputImage,
    class TFunction = Functor::PolarimetricSynthesisFunctor<
        typename TInputImageHH::PixelType,
        typename TInputImageHV::PixelType,
        typename TInputImageVH::PixelType,
        typename TInputImageVV::PixelType,
        typename TOutputImage::PixelType> >
class ITK_EXPORT PolarimetricSynthesisFilter :  public otb::QuaternaryFunctorImageFilter<TInputImageHH,
      TInputImageHV, TInputImageVH,
      TInputImageVV, TOutputImage,
      TFunction>
{
public:

  typedef PolarimetricSynthesisFilter Self;
  typedef otb::QuaternaryFunctorImageFilter<TInputImageHH, TInputImageHV,
      TInputImageVH, TInputImageVV, TOutputImage, TFunction>  Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(PolarimetricSynthesisFilter, QuaternaryFunctorImageFilter);

  typedef std::complex <double>                    InputPixelType;
  typedef otb::Image<InputPixelType,  2>           InputImageType;
  typedef typename Superclass::Input1ImageType     HHInputImageType;
  typedef typename Superclass::Input1ImagePointer  HHInputImagePointer;
  typedef typename Superclass::Input2ImageType     HVInputImageType;
  typedef typename Superclass::Input2ImagePointer  HVInputImagePointer;
  typedef typename Superclass::Input3ImageType     VHInputImageType;
  typedef typename Superclass::Input3ImagePointer  VHInputImagePointer;
  typedef typename Superclass::Input4ImageType     VVInputImageType;
  typedef typename Superclass::Input4ImagePointer  VVInputImagePointer;
  typedef typename Superclass::OutputImageType     OutputImageType;
  typedef typename OutputImageType::Pointer        OutputImagePointer;
  typedef typename OutputImageType::RegionType     OutputImageRegionType;
  typedef typename Superclass::FunctorType         FunctorType;
  typedef typename std::complex <double>           ComplexType;
  typedef typename itk::FixedArray<ComplexType, 2> ComplexArrayType;

  void SetInputHH(const TInputImageHH * image);
  void SetInputHV(const TInputImageHV * image);
  void SetInputVH(const TInputImageVH * image);
  void SetInputVV(const TInputImageVV * image);

  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(Mode, int);
  itkGetMacro(Mode, int);
  itkSetMacro(Gain, double);
  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();
  }
  void ForceCoPolar();
  void ForceCrossPolar();

protected:
  PolarimetricSynthesisFilter();
  virtual ~PolarimetricSynthesisFilter() {}

  virtual void GenerateOutputInformation();

  virtual void BeforeThreadedGenerateData();

  virtual void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
                                    int threadId);

  void ComputeElectromagneticFields();

  void VerifyAndForceInputs();

  void PrintSelf(std::ostream& os, itk::Indent indent) const;

private:

  PolarimetricSynthesisFilter(const Self &); //purposely not implemented
  void operator =(const Self&); //purposely not implemented

  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;
  bool                      m_PresentInputImages[4];

};

} // end namespace otb

#ifndef OTB_MANUAL_INSTANTIATION
#include "otbPolarimetricSynthesisFilter.txx"
#endif

#endif