Documentation for vtkImageDifference

vtkImageDifference - Compares images for regression tests.

Super Class: vtkImageTwoInputFilter

Description:

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 one pixel. Threshold is the allowable error for each pixel.

 

Methods:

void vtkImageDifference ()
static vtkImageDifference *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetImage (vtkImageCache *)
void SetImage (vtkStructuredPoints *)
vtkImageCache *GetImage ()
void SetInput (vtkImageCache *)
void SetInput (vtkStructuredPoints *)
vtkImageCache *GetInput ()
float GetError ()
void GetError (float *)
float GetThresholdedError ()
void GetThresholdedError (float *)
void SetThreshold (int )
int GetThreshold ()
void SetAllowShift (int )
int GetAllowShift ()
void AllowShiftOn ()
void AllowShiftOff ()
void SetAveraging (int )
int GetAveraging ()
void AveragingOn ()
void AveragingOff ()
void ExecuteImageInformation ()
void ComputeRequiredInputUpdateExtent (int ,int ,int )
void ThreadedExecute (vtkImageData ,vtkImageData * ,int ,int )

 

Detailed Method Descriptions:

Specify the Image to compare the input to.

void SetImage (vtkImageCache *)
void SetImage (vtkStructuredPoints *)

Specify the Input for comparison.

vtkImageCache *GetImage ()
void SetInput (vtkImageCache *)
void SetInput (vtkStructuredPoints *)

Return the total error in comparing the two images.

vtkImageCache *GetInput ()
float GetError ()
void GetError (float *)

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.

float GetThresholdedError ()
void GetThresholdedError (float *)

Specify a threshold tolorance for pixel differences.

void SetThreshold (int )
int GetThreshold ()

Specify whether the comparison will allow a shift of one pixel 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.

void SetAllowShift (int )
int GetAllowShift ()
void AllowShiftOn ()
void AllowShiftOff ()

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.

void SetAveraging (int )
int GetAveraging ()
void AveragingOn ()
void AveragingOff ()