mitkCompareImageDataFilter.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef MITKCOMPAREIMAGEDATAFILTER_H
#define MITKCOMPAREIMAGEDATAFILTER_H

// MITK
#include "mitkImage.h"
#include "mitkImageToImageFilter.h"

// ITK
#include <itkImage.h>

namespace mitk
{
  struct CompareFilterResults
  {
    void PrintSelf()
    {
      if (!m_FilterCompleted)
      {
        MITK_INFO << "Comparison filter terminated due to an exception: \n " << m_ExceptionMessage;

        return;
      }

      MITK_INFO << "Min. difference: " << m_MinimumDifference << "\n"
                << "Max. difference: " << m_MaximumDifference << "\n"
                << "Total difference: " << m_TotalDifference << "\n"
                << "Mean difference: " << m_MeanDifference << "\n"
                << "Number of pixels with differences: " << m_PixelsWithDifference;
    }

    double m_MinimumDifference;
    double m_MaximumDifference;

    double m_TotalDifference;
    double m_MeanDifference;
    size_t m_PixelsWithDifference;

    bool m_FilterCompleted;
    std::string m_ExceptionMessage;
  };

  class MITKCORE_EXPORT CompareImageDataFilter : public ImageToImageFilter
  {
  public:
    mitkClassMacro(CompareImageDataFilter, ImageToImageFilter);
    itkSimpleNewMacro(Self);

      bool GetResult(size_t threshold = 0);

    CompareFilterResults GetCompareResults() { return m_CompareDetails; }
    void SetTolerance(double eps) { m_Tolerance = eps; }
  protected:
    CompareImageDataFilter();
    ~CompareImageDataFilter() override {}
    void GenerateData() override;

    void ResetCompareResultsToInitial();

    template <typename TPixel, unsigned int VImageDimension>
    void EstimateValueDifference(const itk::Image<TPixel, VImageDimension> *itkImage1,
                                 const mitk::Image *referenceImage);
    bool m_CompareResult;

    CompareFilterResults m_CompareDetails;
    double m_Tolerance;
  };
} // end namespace mitk

#endif // MITKCompareImageDataFilter_H