itkTestingComparisonImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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 itkTestingComparisonImageFilter_h
#define itkTestingComparisonImageFilter_h
 
#include "itkArray.h"
#include "itkNumericTraits.h"
#include "itkImageToImageFilter.h"
#include <mutex>
 
namespace itk::Testing
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ComparisonImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ComparisonImageFilter);

  using Self = ComparisonImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ComparisonImageFilter);

  using InputImageType = TInputImage;
  using InputPixelType = typename InputImageType::PixelType;
  using OutputImageType = TOutputImage;
  using OutputPixelType = typename OutputImageType::PixelType;
  using OutputImageRegionType = typename OutputImageType::RegionType;
  using RealType = typename NumericTraits<OutputPixelType>::RealType;
  using AccumulateType = typename NumericTraits<RealType>::AccumulateType;

  itkSetInputMacro(ValidInput, InputImageType);

  itkSetInputMacro(TestInput, InputImageType);

  itkSetMacro(VerifyInputInformation, bool);
  itkGetConstMacro(VerifyInputInformation, bool);
  itkBooleanMacro(VerifyInputInformation);

  itkSetMacro(ToleranceRadius, int);
  itkGetConstMacro(ToleranceRadius, int);

  itkSetMacro(DifferenceThreshold, OutputPixelType);
  itkGetConstMacro(DifferenceThreshold, OutputPixelType);

  itkSetMacro(IgnoreBoundaryPixels, bool);
  itkGetConstMacro(IgnoreBoundaryPixels, bool);
  itkBooleanMacro(IgnoreBoundaryPixels);

  itkGetConstMacro(MinimumDifference, OutputPixelType);
  itkGetConstMacro(MaximumDifference, OutputPixelType);
  itkGetConstMacro(MeanDifference, RealType);
  itkGetConstMacro(TotalDifference, AccumulateType);
  itkGetConstMacro(NumberOfPixelsWithDifferences, SizeValueType);
 
protected:
  ComparisonImageFilter();
  ~ComparisonImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType &) override;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  AfterThreadedGenerateData() override;
 
  void
  VerifyInputInformation() const override;
 
  OutputPixelType m_DifferenceThreshold{};
 
  RealType        m_MeanDifference{};
  OutputPixelType m_MinimumDifference{ NumericTraits<OutputPixelType>::max() };
  OutputPixelType m_MaximumDifference{ NumericTraits<OutputPixelType>::NonpositiveMin() };
  bool            m_VerifyInputInformation{ true };
 
  AccumulateType m_TotalDifference{};
 
  SizeValueType m_NumberOfPixelsWithDifferences{ 0 };
 
  int m_ToleranceRadius{ 0 };
 
private:
  bool m_IgnoreBoundaryPixels{ false };
 
  std::mutex m_Mutex;
};
} // namespace itk::Testing
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkTestingComparisonImageFilter.hxx"
#endif
 
 
#endif