otbSubPixelDisparityImageFilter.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 otbSubPixelDisparityImageFilter_h
#define otbSubPixelDisparityImageFilter_h
 
#include "otbPixelWiseBlockMatchingImageFilter.h"
 
#include "itkTranslationTransform.h"
#include "itkResampleImageFilter.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputMetricImage, class TDisparityImage = TOutputMetricImage, class TMaskImage = otb::Image<unsigned char>,
          class TBlockMatchingFunctor = Functor::SSDBlockMatching<TInputImage, TOutputMetricImage>>
class ITK_EXPORT SubPixelDisparityImageFilter : public itk::ImageToImageFilter<TInputImage, TDisparityImage>
{
public:
  typedef SubPixelDisparityImageFilter Self;
  typedef itk::ImageToImageFilter<TInputImage, TDisparityImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(SubPixelDisparityImageFilter, ImageToImageFilter);
 
  typedef TInputImage           InputImageType;
  typedef TOutputMetricImage    OutputMetricImageType;
  typedef TDisparityImage       OutputDisparityImageType;
  typedef TMaskImage            InputMaskImageType;
  typedef TBlockMatchingFunctor BlockMatchingFunctorType;
 
  typedef typename InputImageType::SizeType    SizeType;
  typedef typename InputImageType::IndexType   IndexType;
  typedef typename InputImageType::RegionType  RegionType;
  typedef typename InputImageType::SpacingType SpacingType;
  typedef typename InputImageType::PointType   PointType;
 
  typedef typename TOutputMetricImage::ValueType MetricValueType;
 
  typedef typename OutputDisparityImageType::PixelType DisparityPixelType;
 
  typedef itk::ConstNeighborhoodIterator<TInputImage> ConstNeighborhoodIteratorType;
 
  typedef itk::ResampleImageFilter<TInputImage, TInputImage, double> ResamplerFilterType;
  typedef itk::TranslationTransform<double, 2> TransformationType;
  typedef otb::PixelWiseBlockMatchingImageFilter<InputImageType, OutputMetricImageType, OutputDisparityImageType, InputMaskImageType, BlockMatchingFunctorType>
      BlockMatchingFilterType;
 
  itkStaticConstMacro(PARABOLIC, int, 0);
  itkStaticConstMacro(TRIANGULAR, int, 1);
  itkStaticConstMacro(DICHOTOMY, int, 2);
 
  void SetLeftInput(const TInputImage* image);
 
  void SetRightInput(const TInputImage* image);
 
  void SetHorizontalDisparityInput(const TDisparityImage* hfield);
 
  void SetVerticalDisparityInput(const TDisparityImage* vfield);
 
  void SetMetricInput(const TOutputMetricImage* image);
 
  const TDisparityImage* GetHorizontalDisparityInput() const;
  const TDisparityImage* GetVerticalDisparityInput() const;
 
  void SetLeftMaskInput(const TMaskImage* image);
 
  void SetRightMaskInput(const TMaskImage* image);
 
  const TInputImage* GetLeftInput() const;
  const TInputImage* GetRightInput() const;
  const TMaskImage*  GetLeftMaskInput() const;
  const TMaskImage*  GetRightMaskInput() const;
 
  const TOutputMetricImage* GetMetricOutput() const;
  TOutputMetricImage*       GetMetricOutput();
 
  const TDisparityImage* GetHorizontalDisparityOutput() const;
  TDisparityImage*       GetHorizontalDisparityOutput();
 
  const TDisparityImage* GetVerticalDisparityOutput() const;
  TDisparityImage*       GetVerticalDisparityOutput();
 
  void SetRadius(unsigned int radius)
  {
    m_Radius.Fill(radius);
  }
 
  itkSetMacro(Radius, SizeType);
  itkGetConstReferenceMacro(Radius, SizeType);
 
  itkSetMacro(MinimumHorizontalDisparity, int);
  itkGetConstReferenceMacro(MinimumHorizontalDisparity, int);
 
  itkSetMacro(MaximumHorizontalDisparity, int);
  itkGetConstReferenceMacro(MaximumHorizontalDisparity, int);
 
  itkSetMacro(MinimumVerticalDisparity, int);
  itkGetConstReferenceMacro(MinimumVerticalDisparity, int);
 
  itkSetMacro(MaximumVerticalDisparity, int);
  itkGetConstReferenceMacro(MaximumVerticalDisparity, int);
 
  itkSetMacro(Minimize, bool);
  itkGetConstReferenceMacro(Minimize, bool);
  itkBooleanMacro(Minimize);
 
  BlockMatchingFunctorType& GetFunctor()
  {
    return m_Functor;
  }
 
  const BlockMatchingFunctorType& GetFunctor() const
  {
    return m_Functor;
  }
 
  itkSetMacro(RefineMethod, int);
  itkGetMacro(RefineMethod, int);
 
  void SetInputsFromBlockMatchingFilter(const BlockMatchingFilterType* filter);
 
protected:
  SubPixelDisparityImageFilter();
 
  ~SubPixelDisparityImageFilter() override;
 
  void VerifyInputInformation() const override;
 
  void GenerateOutputInformation() override;
 
  void GenerateInputRequestedRegion() override;
 
  void BeforeThreadedGenerateData() override;
 
  void ThreadedGenerateData(const RegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
 
  void AfterThreadedGenerateData() override;
 
private:
  SubPixelDisparityImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  void ParabolicRefinement(const RegionType& outputRegionForThread, itk::ThreadIdType threadId);
 
  void TriangularRefinement(const RegionType& outputRegionForThread, itk::ThreadIdType threadId);
 
  void DichotomyRefinement(const RegionType& outputRegionForThread, itk::ThreadIdType threadId);
 
  SizeType m_Radius;
 
  int m_MinimumHorizontalDisparity;
 
  int m_MaximumHorizontalDisparity;
 
  int m_MinimumVerticalDisparity;
 
  int m_MaximumVerticalDisparity;
 
  bool m_Minimize;
 
  BlockMatchingFunctorType m_Functor;
 
  int m_RefineMethod;
 
  std::vector<double> m_WrongExtrema;
 
  unsigned int m_Step;
 
  IndexType m_GridIndex;
};
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbSubPixelDisparityImageFilter.hxx"
#endif
 
#endif