vtkImageDifference.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkImageDifference_h
#define vtkImageDifference_h
 
#include "vtkImagingCoreModule.h" // For export macro
#include "vtkSmartPointer.h"      // For smart pointer
#include "vtkThreadedImageAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkImageDifferenceThreadData;
class vtkImageDifferenceSMPThreadLocal;
 
class VTKIMAGINGCORE_EXPORT vtkImageDifference : public vtkThreadedImageAlgorithm
{
public:
  static vtkImageDifference* New();
  vtkTypeMacro(vtkImageDifference, vtkThreadedImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetImageConnection(vtkAlgorithmOutput* output) { this->SetInputConnection(1, output); }
  void SetImageData(vtkDataObject* image) { this->SetInputData(1, image); }
  vtkImageData* GetImage();
 
  double GetError() { return this->Error; }
  void GetError(double* e) { *e = this->GetError(); }
 
  double GetThresholdedError() { return this->ThresholdedError; }
  void GetThresholdedError(double* e) { *e = this->GetThresholdedError(); }
 
 
  vtkSetMacro(Threshold, int);
  vtkGetMacro(Threshold, int);
 
 
  vtkSetMacro(AllowShift, bool);
  vtkGetMacro(AllowShift, bool);
  vtkBooleanMacro(AllowShift, bool);
 
 
  vtkSetMacro(Averaging, bool);
  vtkGetMacro(Averaging, bool);
  vtkBooleanMacro(Averaging, bool);
 
 
  vtkSetMacro(AverageThresholdFactor, double);
  vtkGetMacro(AverageThresholdFactor, double);
 
protected:
  vtkImageDifference();
  ~vtkImageDifference() override = default;
 
  // Parameters
  // ideally threshold * averageThresholdFactor should be < 255/9
  // to capture one pixel errors or 510/9 to capture 2 pixel errors
  bool AllowShift = true;
  bool Averaging = true;
  int Threshold = 105;
  double AverageThresholdFactor = 0.65;
 
  // Outputs
  const char* ErrorMessage = nullptr;
  double Error = 0.;
  double ThresholdedError = 0.;
 
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  void ThreadedRequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
    int outExt[6], int threadId) override;
 
  void GrowExtent(int* uExt, int* wholeExtent);
  int ComputeSumedValue(unsigned char* values, vtkIdType* indices, int comp);
 
  // Used for vtkMultiThreader operation.
  vtkImageDifferenceThreadData* ThreadData;
 
  // Used for vtkSMPTools operation.
  vtkImageDifferenceSMPThreadLocal* SMPThreadData = nullptr;
 
private:
  vtkImageDifference(const vtkImageDifference&) = delete;
  void operator=(const vtkImageDifference&) = delete;
 
  friend class vtkImageDifferenceSMPFunctor;
};
 
VTK_ABI_NAMESPACE_END
#endif