1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkImageDifference
* @brief Compares images for regression tests.
*
* vtkImageDifference takes two rgb unsigned char images and compares them.
* It allows the images to be slightly different. If AllowShift is on,
* then each pixel can be shifted by two pixels. Threshold is the allowable
* error for each pixel.
*
* This is a symmetric filter and the difference computed is symmetric.
* The resulting value is the maximum error of the two directions
* A->B and B->A
*/
#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;
///@{
/**
* Specify the Image to compare the input to.
*/
void SetImageConnection(vtkAlgorithmOutput* output) { this->SetInputConnection(1, output); }
void SetImageData(vtkDataObject* image) { this->SetInputData(1, image); }
vtkImageData* GetImage();
///@}
/**
* Return the total error in comparing the two images.
*/
double GetError() { return this->Error; }
void GetError(double* e) { *e = this->GetError(); }
/**
* Return the total thresholded error in comparing the two images.
* The thresholded error is the error for a given pixel minus the
* threshold and clamped at a minimum of zero.
*/
double GetThresholdedError() { return this->ThresholdedError; }
void GetThresholdedError(double* e) { *e = this->GetThresholdedError(); }
///@{
/**
* Specify a threshold tolerance for pixel differences.
*/
vtkSetMacro(Threshold, int);
vtkGetMacro(Threshold, int);
///@}
///@{
/**
* Specify whether the comparison will allow a shift of two
* pixels between the images. If set, then the minimum difference
* between input images will be used to determine the difference.
* Otherwise, the difference is computed directly between pixels
* of identical row/column values.
*/
vtkSetMacro(AllowShift, bool);
vtkGetMacro(AllowShift, bool);
vtkBooleanMacro(AllowShift, bool);
///@}
///@{
/**
* Specify whether the comparison will include comparison of
* averaged 3x3 data between the images. For graphics renderings
* you normally would leave this on. For imaging operations it
* should be off.
*/
vtkSetMacro(Averaging, bool);
vtkGetMacro(Averaging, bool);
vtkBooleanMacro(Averaging, bool);
///@}
///@{
/**
* When doing Averaging, adjust the threshold for the average
* by this factor. Defaults to 0.5 requiring a better match
*/
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
|
