otbDifferenceImageFilter.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 otbDifferenceImageFilter_h
#define otbDifferenceImageFilter_h
 
#include "otbPersistentImageFilter.h"
#include "itkNumericTraits.h"
#include "itkArray.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage>
class ITK_EXPORT DifferenceImageFilter : public otb::PersistentImageFilter <TInputImage, TOutputImage>
{
public:
  typedef DifferenceImageFilter Self;
  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(DifferenceImageFilter, ImageToImageFilter);
 
  typedef TInputImage                                                  InputImageType;
  typedef TOutputImage                                                 OutputImageType;
  typedef typename OutputImageType::PixelType                          OutputPixelType;
  typedef typename OutputImageType::RegionType                         OutputImageRegionType;
  typedef typename itk::NumericTraits<OutputPixelType>::RealType       RealType;
  typedef typename itk::NumericTraits<RealType>::AccumulateType        AccumulateType;
  typedef typename itk::NumericTraits<OutputPixelType>::ScalarRealType ScalarRealType;
 
  virtual void SetValidInput(const InputImageType* validImage);
 
  virtual void SetTestInput(const InputImageType* testImage);
 
  itkSetMacro(ToleranceRadius, int);
  itkGetMacro(ToleranceRadius, int);
 
  itkSetMacro(DifferenceThreshold, ScalarRealType);
  itkGetMacro(DifferenceThreshold, ScalarRealType);
 
  itkGetMacro(MeanDifference, RealType);
  itkGetMacro(TotalDifference, AccumulateType);
  itkGetMacro(NumberOfPixelsWithDifferences, unsigned long);
 
  void Synthetize(void) override;
  void Reset(void) override;
 
protected:
  DifferenceImageFilter();
  ~DifferenceImageFilter() = default;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void ThreadedGenerateData(const OutputImageRegionType& threadRegion, itk::ThreadIdType threadId) override;
 
  void GenerateOutputInformation() override;
  
  ScalarRealType m_DifferenceThreshold;
  RealType       m_MeanDifference;
  AccumulateType m_TotalDifference;
  unsigned long  m_NumberOfPixelsWithDifferences;
  int            m_ToleranceRadius;
 
  std::vector<AccumulateType> m_ThreadDifferenceSum;
  itk::Array<unsigned long>   m_ThreadNumberOfPixels;
 
private:
  DifferenceImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbDifferenceImageFilter.hxx"
#endif
 
#endif