vtkImageSSIM.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 vtkImageSSIM_h
#define vtkImageSSIM_h

#include "vtkImagingCoreModule.h" // For export macro
#include "vtkSmartPointer.h"      // For smart pointer
#include "vtkThreadedImageAlgorithm.h"

#include <array>
#include <vector>

VTK_ABI_NAMESPACE_BEGIN
class vtkDoubleArray;
class vtkImageSSIMThreadData;
class vtkImageSSIMSMPThreadLocal;
class VTKIMAGINGCORE_EXPORT vtkImageSSIM : public vtkThreadedImageAlgorithm
{
public:
  static vtkImageSSIM* New();
  vtkTypeMacro(vtkImageSSIM, vtkThreadedImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetImageConnection(vtkAlgorithmOutput* output) { this->SetInputConnection(1, output); }
  void SetImageData(vtkDataObject* image) { this->SetInputData(1, image); }

  void SetInputToLab();

  void SetInputToRGB();

  void SetInputToRGBA();

  void SetInputToGrayscale();

  void SetInputToAuto();

  void SetInputRange(std::vector<int>& range);


  vtkSetMacro(ClampNegativeValues, bool);
  vtkGetMacro(ClampNegativeValues, bool);
  vtkBooleanMacro(ClampNegativeValues, bool);


  vtkSetMacro(PatchRadius, double);
  vtkGetMacro(PatchRadius, double);

  static void ComputeErrorMetrics(vtkDoubleArray* scalars, double& tight, double& loose);

protected:
  vtkImageSSIM();
  ~vtkImageSSIM() override = default;

  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  using Superclass::AllocateOutputData;
  void AllocateOutputData(
    vtkImageData* output, vtkInformation* outInfo, VTK_FUTURE_CONST int uExtent[6]) override;

  void ThreadedRequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
    VTK_FUTURE_CONST int outExt[6], int threadId) override;

  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

private:
  void SetInputToAdditiveChar(unsigned int size);
  void GrowExtent(int uExt[2], VTK_FUTURE_CONST int wholeExtent[2]);

  int PatchRadius = 6;
  bool ClampNegativeValues = false;

  enum
  {
    MODE_LAB,
    MODE_RGB,
    MODE_RGBA,
    MODE_GRAYSCALE,
    MODE_AUTO,
    MODE_INPUT_RANGE
  };
  int Mode = MODE_AUTO;

  std::vector<std::array<double, 2>> C;

  vtkImageSSIM(const vtkImageSSIM&) = delete;
  void operator=(const vtkImageSSIM&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif