otbLmvmPanSharpeningFusionImageFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * 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 otbLmvmPanSharpeningFusionImageFilter_h
#define otbLmvmPanSharpeningFusionImageFilter_h
 
#include "otbConvolutionImageFilter.h"
#include "otbFunctorImageFilter.h"
#include "otbPerBandVectorImageFilter.h"
#include "itkNoiseImageFilter.h"
#include "otbVectorImage.h"
 
#include "itkProgressAccumulator.h"
 
 
namespace otb
{
template <class TPanImageType, class TXsImageType, class TOutputImageType, class TInternalPrecision = float>
class ITK_EXPORT LmvmPanSharpeningFusionImageFilter : public itk::ImageToImageFilter<TXsImageType, TOutputImageType>
{
public:
  typedef LmvmPanSharpeningFusionImageFilter Self;
  typedef itk::ImageToImageFilter<TXsImageType, TOutputImageType> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef otb::Image<TInternalPrecision, TPanImageType::ImageDimension> InternalImageType;
 
  typedef typename TXsImageType::InternalPixelType XsPixelType;
  typedef otb::Image<XsPixelType, TXsImageType::ImageDimension> XsBandImageType;
 
  typedef otb::VectorImage<TInternalPrecision, TXsImageType::ImageDimension> InternalVectorImageType;
 
  typedef typename itk::Array<TInternalPrecision> ArrayType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(LmvmPanSharpeningFusionImageFilter, itk::ImageToImageFilter);
 
  typedef typename InternalImageType::SizeType RadiusType;
 
  itkGetMacro(Radius, RadiusType);
  itkSetMacro(Radius, RadiusType);
 
  itkSetMacro(Filter, ArrayType);
  itkGetConstReferenceMacro(Filter, ArrayType);
 
  virtual void SetPanInput(const TPanImageType* image);
  const TPanImageType* GetPanInput(void) const;
 
  virtual void SetXsInput(const TXsImageType* path);
  const TXsImageType* GetXsInput(void) const;
 
protected:
  LmvmPanSharpeningFusionImageFilter();
 
  ~LmvmPanSharpeningFusionImageFilter() override{};
 
  void GenerateData() override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  LmvmPanSharpeningFusionImageFilter(Self&); // intentionally not implemented
  void operator=(const Self&);               // intentionally not implemented
 
  class FusionFunctor1
  {
  public:
    // Implement the fusion as a six arguments operator
    void operator()(typename TOutputImageType::PixelType& output, const typename InternalVectorImageType::PixelType& stdXsPixel,
                    const TInternalPrecision& smoothPanchroPixel, const typename TPanImageType::PixelType& sharpPanchroPixel) const
    {
      // Perform fusion for each band with appropriate casting
      for (unsigned int i = 0; i < stdXsPixel.Size(); ++i)
      {
        output[i] = static_cast<typename TOutputImageType::InternalPixelType>(((sharpPanchroPixel - smoothPanchroPixel) * stdXsPixel[i]));
      }
    }
    constexpr size_t OutputSize(const std::array<size_t, 3> inputsNbBands) const
    {
      return inputsNbBands[0];
    }
  };
 
  class FusionFunctor2
  {
  public:
    // Implement the fusion as a six arguments operator
    void operator()(typename TOutputImageType::PixelType& output, const typename TOutputImageType::PixelType& functor1Pixel,
                    const typename InternalVectorImageType::PixelType& smoothXsPixel, const TInternalPrecision& stdPanchroPixel) const
    {
      TInternalPrecision scale = 1.;
 
      if (std::abs(stdPanchroPixel) > 1e-10)
      {
        scale = 1.0 / stdPanchroPixel;
      }
 
      // Perform fusion for each band with appropriate casting
      for (unsigned int i = 0; i < smoothXsPixel.Size(); ++i)
      {
        output[i] = static_cast<typename TOutputImageType::InternalPixelType>(((functor1Pixel[i] * scale) + smoothXsPixel[i]));
      }
    }
 
    constexpr size_t OutputSize(const std::array<size_t, 3> inputsNbBands) const
    {
      return inputsNbBands[0];
    }
  };
 
  typedef FunctorImageFilter<FusionFunctor1> FusionStep1FilterType;
 
  typename FusionStep1FilterType::Pointer m_FusionStep1Filter;
 
 
  typedef FunctorImageFilter<FusionFunctor2> FusionStep2FilterType;
 
  typename FusionStep2FilterType::Pointer m_FusionStep2Filter;
 
 
  typedef otb::ConvolutionImageFilter<TPanImageType, InternalImageType, itk::ZeroFluxNeumannBoundaryCondition<TPanImageType>, TInternalPrecision>
      PanConvolutionFilterType;
 
  typename PanConvolutionFilterType::Pointer m_PanConvolutionFilter;
 
  typedef otb::ConvolutionImageFilter<XsBandImageType, InternalImageType, itk::ZeroFluxNeumannBoundaryCondition<TPanImageType>, TInternalPrecision>
      XsConvolutionFilterType;
 
  typename XsConvolutionFilterType::Pointer m_XsConvolutionFilter;
 
  typedef itk::NoiseImageFilter<TPanImageType, InternalImageType> PanNoiseFilterType;
 
  typename PanNoiseFilterType::Pointer m_PanNoiseFilter;
 
  typedef itk::NoiseImageFilter<XsBandImageType, InternalImageType> XsNoiseFilterType;
 
  typename XsNoiseFilterType::Pointer m_XsNoiseFilter;
 
  typedef otb::PerBandVectorImageFilter<TXsImageType, InternalVectorImageType, XsConvolutionFilterType> XsVectorConvolutionFilterType;
 
  typename XsVectorConvolutionFilterType::Pointer m_XsVectorConvolutionFilter;
 
  typedef otb::PerBandVectorImageFilter<TXsImageType, InternalVectorImageType, XsNoiseFilterType> XsVectorNoiseFilterType;
 
  typename XsVectorNoiseFilterType::Pointer m_XsVectorNoiseFilter;
 
  RadiusType m_Radius;
 
  ArrayType m_Filter;
 
  typename itk::ProgressAccumulator::Pointer m_ProgressAccumulator;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbLmvmPanSharpeningFusionImageFilter.hxx"
#endif
 
#endif