otbStreamingCompareImageFilter.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 otbStreamingCompareImageFilter_h
#define otbStreamingCompareImageFilter_h
 
#include "otbPersistentImageFilter.h"
#include "itkNumericTraits.h"
#include "itkArray.h"
#include "itkSimpleDataObjectDecorator.h"
#include "otbPersistentFilterStreamingDecorator.h"
 
namespace otb
{
 
template <class TInputImage>
class ITK_EXPORT PersistentCompareImageFilter : public PersistentImageFilter<TInputImage, TInputImage>
{
public:
  typedef PersistentCompareImageFilter Self;
  typedef PersistentImageFilter<TInputImage, TInputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PersistentCompareImageFilter, PersistentImageFilter);
 
  typedef TInputImage                   ImageType;
  typedef typename TInputImage::Pointer InputImagePointer;
 
  typedef typename TInputImage::RegionType                   RegionType;
  typedef typename TInputImage::SizeType                     SizeType;
  typedef typename TInputImage::IndexType                    IndexType;
  typedef typename TInputImage::PixelType                    PixelType;
  typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
 
  itkStaticConstMacro(InputImageDimension, unsigned int, TInputImage::ImageDimension);
 
  itkStaticConstMacro(ImageDimension, unsigned int, TInputImage::ImageDimension);
 
  typedef typename itk::NumericTraits<PixelType>::RealType RealType;
 
  typedef typename itk::DataObject::Pointer DataObjectPointer;
 
  typedef itk::SimpleDataObjectDecorator<RealType>  RealObjectType;
  typedef itk::SimpleDataObjectDecorator<PixelType> PixelObjectType;
 
  const TInputImage* GetInput1();
  const TInputImage* GetInput2();
 
  void SetInput1(const TInputImage* image);
 
  void SetInput2(const TInputImage* image);
 
  RealType GetPSNR() const
  {
    return this->GetPSNROutput()->Get();
  }
  RealObjectType*       GetPSNROutput();
  const RealObjectType* GetPSNROutput() const;
 
  RealType GetMSE() const
  {
    return this->GetMSEOutput()->Get();
  }
  RealObjectType*       GetMSEOutput();
  const RealObjectType* GetMSEOutput() const;
 
  RealType GetMAE() const
  {
    return this->GetMAEOutput()->Get();
  }
  RealObjectType*       GetMAEOutput();
  const RealObjectType* GetMAEOutput() const;
 
  RealType GetDiffCount() const
  {
    return this->GetDiffCountOutput()->Get();
  }
  RealObjectType*       GetDiffCountOutput();
  const RealObjectType* GetDiffCountOutput() const;
 
  itkGetMacro(PhysicalSpaceCheck, bool);
  itkSetMacro(PhysicalSpaceCheck, bool);
 
  DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) override;
  using Superclass::MakeOutput;
 
  void AllocateOutputs() override;
  void GenerateOutputInformation() override;
  void Synthetize(void) override;
  void Reset(void) override;
 
protected:
  PersistentCompareImageFilter();
  ~PersistentCompareImageFilter() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void ThreadedGenerateData(const RegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
 
  void VerifyInputInformation() const override;
 
private:
  PersistentCompareImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  itk::Array<RealType>  m_SquareOfDifferences;
  itk::Array<RealType>  m_AbsoluteValueOfDifferences;
  itk::Array<PixelType> m_ThreadMinRef;
  itk::Array<PixelType> m_ThreadMaxRef;
  itk::Array<long>      m_Count;
  itk::Array<long>      m_DiffCount;
  bool                  m_PhysicalSpaceCheck;
}; // end of class PersistentCompareImageFilter
 
/*===========================================================================*/
 
template <class TInputImage>
class ITK_EXPORT StreamingCompareImageFilter : public PersistentFilterStreamingDecorator<PersistentCompareImageFilter<TInputImage>>
{
public:
  typedef StreamingCompareImageFilter                                                   Self;
  typedef PersistentFilterStreamingDecorator<PersistentCompareImageFilter<TInputImage>> Superclass;
  typedef itk::SmartPointer<Self>                                                       Pointer;
  typedef itk::SmartPointer<const Self>                                                 ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingCompareImageFilter, PersistentFilterStreamingDecorator);
 
  typedef typename Superclass::FilterType       CompareFilterType;
  typedef typename CompareFilterType::PixelType PixelType;
  typedef typename CompareFilterType::RealType  RealType;
  typedef TInputImage                           InputImageType;
 
  typedef itk::SimpleDataObjectDecorator<RealType>  RealObjectType;
  typedef itk::SimpleDataObjectDecorator<PixelType> PixelObjectType;
 
  void SetInput1(InputImageType* input)
  {
    this->GetFilter()->SetInput1(input);
  }
 
  void SetInput2(InputImageType* input)
  {
    this->GetFilter()->SetInput2(input);
  }
 
  RealType GetPSNR() const
  {
    return this->GetFilter()->GetPSNROutput()->Get();
  }
  RealObjectType* GetPSNROutput()
  {
    return this->GetFilter()->GetPSNROutput();
  }
  const RealObjectType* GetPSNROutput() const
  {
    return this->GetFilter()->GetPSNROutput();
  }
 
  RealType GetMSE() const
  {
    return this->GetMSEOutput()->Get();
  }
  RealObjectType* GetMSEOutput()
  {
    return this->GetFilter()->GetMSEOutput();
  }
  const RealObjectType* GetMSEOutput() const
  {
    return this->GetFilter()->GetMSEOutput();
  }
 
  RealType GetMAE() const
  {
    return this->GetFilter()->GetMAEOutput()->Get();
  }
  RealObjectType* GetMAEOutput()
  {
    return this->GetFilter()->GetMAEOutput();
  }
  const RealObjectType* GetMAEOutput() const
  {
    return this->GetFilter()->GetMAEOutput();
  }
 
  RealType GetDiffCount() const
  {
    return this->GetFilter()->GetDiffCountOutput()->Get();
  }
  RealObjectType* GetDiffCountOutput()
  {
    return this->GetFilter()->GetDiffCountOutput();
  }
  const RealObjectType* GetDiffCountOutput() const
  {
    return this->GetFilter()->GetDiffCountOutput();
  }
 
  void SetPhysicalSpaceCheck(bool flag)
  {
    this->GetFilter()->SetPhysicalSpaceCheck(flag);
  }
 
  bool GetPhysicalSpaceCheck()
  {
    return this->GetFilter()->GetPhysicalSpaceCheck();
  }
 
protected:
  StreamingCompareImageFilter(){};
 
  ~StreamingCompareImageFilter() override
  {
  }
 
private:
  StreamingCompareImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingCompareImageFilter.hxx"
#endif
 
#endif