otbBinaryFunctorNeighborhoodJoinHistogramImageFilter.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 otbBinaryFunctorNeighborhoodJoinHistogramImageFilter_h
#define otbBinaryFunctorNeighborhoodJoinHistogramImageFilter_h
 
#include "itkBinaryFunctorImageFilter.h"
#include "itkImageRegionIteratorWithIndex.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkHistogram.h"
 
namespace otb
{
 
template <class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
class ITK_EXPORT BinaryFunctorNeighborhoodJoinHistogramImageFilter : public itk::ImageToImageFilter<TInputImage1, TOutputImage>
{
public:
  typedef BinaryFunctorNeighborhoodJoinHistogramImageFilter Self;
  typedef itk::ImageToImageFilter<TInputImage1, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(BinaryFunctorNeighborhoodJoinHistogramImageFilter, ImageToImageFilter);
 
  typedef TFunction                              FunctorType;
  typedef TInputImage1                           Input1ImageType;
  typedef typename Input1ImageType::Pointer      Input1ImagePointer;
  typedef typename Input1ImageType::ConstPointer Input1ImageConstPointer;
  typedef typename Input1ImageType::RegionType   Input1ImageRegionType;
  typedef typename Input1ImageType::PixelType    Input1ImagePixelType;
  typedef TInputImage2                           Input2ImageType;
  typedef typename Input2ImageType::Pointer      Input2ImagePointer;
  typedef typename Input2ImageType::ConstPointer Input2ImageConstPointer;
  typedef typename Input2ImageType::RegionType   Input2ImageRegionType;
  typedef typename Input2ImageType::PixelType    Input2ImagePixelType;
  typedef TOutputImage                           OutputImageType;
  typedef typename OutputImageType::Pointer      OutputImagePointer;
  typedef typename OutputImageType::RegionType   OutputImageRegionType;
  typedef typename OutputImageType::PixelType    OutputImagePixelType;
 
  typedef itk::ProcessObject ProcessObjectType;
 
  typedef itk::ConstNeighborhoodIterator<TInputImage1> NeighborhoodIteratorType1;
  typedef itk::ConstNeighborhoodIterator<TInputImage2> NeighborhoodIteratorType2;
 
  typedef typename NeighborhoodIteratorType1::RadiusType RadiusType1;
  typedef typename NeighborhoodIteratorType2::RadiusType RadiusType2;
 
  typedef unsigned char RadiusSizeType;
 
  typedef typename itk::Statistics::Histogram<double, itk::Statistics::DenseFrequencyContainer2> HistogramType;
  typedef typename HistogramType::MeasurementVectorType MeasurementVectorType;
  typedef typename HistogramType::SizeType              HistogramSizeType;
 
  void SetInput1(const TInputImage1* image1);
 
  void SetInput2(const TInputImage2* image2);
 
  const TInputImage1* GetInput1();
  const TInputImage2* GetInput2();
 
  FunctorType& GetFunctor()
  {
    return m_Functor;
  }
 
  void SetFunctor(const FunctorType& functor)
  {
    m_Functor = functor;
    this->Modified();
  }
 
  itkSetMacro(Radius, RadiusSizeType);
 
  itkSetMacro(UpperBoundIncreaseFactor, double);
  itkGetMacro(UpperBoundIncreaseFactor, double);
 
  itkSetMacro(PaddingValue, Input1ImagePixelType);
 
  itkGetConstReferenceMacro(PaddingValue, Input1ImagePixelType);
 
  itkSetMacro(UsePaddingValue, bool);
  itkGetMacro(UsePaddingValue, bool);
 
protected:
  BinaryFunctorNeighborhoodJoinHistogramImageFilter();
  ~BinaryFunctorNeighborhoodJoinHistogramImageFilter() override
  {
  }
 
  void BeforeThreadedGenerateData() override;
 
  void DynamicThreadedGenerateData(const OutputImageRegionType& outputRegionForThread) override;
 
  void GenerateInputRequestedRegion(void) override;
 
  RadiusSizeType m_Radius;
 
  HistogramType::Pointer m_Histogram;
 
private:
  BinaryFunctorNeighborhoodJoinHistogramImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  void ComputeHistogram();
 
  FunctorType m_Functor;
 
  Input1ImagePixelType m_PaddingValue;
 
  bool m_UsePaddingValue;
 
  double m_UpperBoundIncreaseFactor;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbBinaryFunctorNeighborhoodJoinHistogramImageFilter.hxx"
#endif
 
#endif