ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkImageDifference Class Reference

vtkImageDifference - Compares images for regression tests. More...

Inheritance diagram for Kitware.VTK.vtkImageDifference:
[legend]
Collaboration diagram for Kitware.VTK.vtkImageDifference:
[legend]

List of all members.

Public Member Functions

 vtkImageDifference (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkImageDifference ()
 Undocumented Block.
virtual void AllowShiftOff ()
 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.
virtual void AllowShiftOn ()
 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.
virtual void AveragingOff ()
 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.
virtual void AveragingOn ()
 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.
virtual int GetAllowShift ()
 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.
virtual int GetAveraging ()
 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.
double GetError ()
 Return the total error in comparing the two images.
void GetError (IntPtr e)
 Return the total error in comparing the two images.
vtkImageData GetImage ()
 Specify the Image to compare the input to.
virtual int GetThreshold ()
 Specify a threshold tolerance for pixel differences.
double GetThresholdedError ()
 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.
void GetThresholdedError (IntPtr e)
 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.
override int IsA (string type)
 Undocumented Block.
new vtkImageDifference NewInstance ()
 Undocumented Block.
virtual void SetAllowShift (int _arg)
 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.
virtual void SetAveraging (int _arg)
 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 SetImage (vtkDataObject image)
 Specify the Image to compare the input to.
virtual void SetThreshold (int _arg)
 Specify a threshold tolerance for pixel differences.

Static Public Member Functions

static new vtkImageDifference New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkImageDifference SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkImageDifference"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "18vtkImageDifference"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkImageDifference_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkImageDifference_AllowShiftOff_01 (HandleRef pThis)
static internal void vtkImageDifference_AllowShiftOn_02 (HandleRef pThis)
static internal void vtkImageDifference_AveragingOff_03 (HandleRef pThis)
static internal void vtkImageDifference_AveragingOn_04 (HandleRef pThis)
static internal int vtkImageDifference_GetAllowShift_05 (HandleRef pThis)
static internal int vtkImageDifference_GetAveraging_06 (HandleRef pThis)
static internal double vtkImageDifference_GetError_07 (HandleRef pThis)
static internal void vtkImageDifference_GetError_08 (HandleRef pThis, IntPtr e)
static internal IntPtr vtkImageDifference_GetImage_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkImageDifference_GetThreshold_10 (HandleRef pThis)
static internal double vtkImageDifference_GetThresholdedError_11 (HandleRef pThis)
static internal void vtkImageDifference_GetThresholdedError_12 (HandleRef pThis, IntPtr e)
static internal int vtkImageDifference_IsA_13 (HandleRef pThis, string type)
static internal int vtkImageDifference_IsTypeOf_14 (string type)
static internal IntPtr vtkImageDifference_NewInstance_16 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkImageDifference_SafeDownCast_17 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkImageDifference_SetAllowShift_18 (HandleRef pThis, int _arg)
static internal void vtkImageDifference_SetAveraging_19 (HandleRef pThis, int _arg)
static internal void vtkImageDifference_SetImage_20 (HandleRef pThis, HandleRef image)
static internal void vtkImageDifference_SetThreshold_21 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkImageDifference ()
 Automatically generated type registration mechanics.

Detailed Description

vtkImageDifference - Compares images for regression tests.

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.

This is not a symetric filter and the difference computed is not symetric when AllowShift is on. Specifically in that case a pixel in SetImage input will be compared to the matching pixel in the input as well as to the input's eight connected neighbors. BUT... the opposite is not true. So for example if a valid image (SetImage) has a single white pixel in it, it will not find a match in the input image if the input image is black (because none of the nine suspect pixels are white). In contrast, if there is a single white pixel in the input image and the valid image (SetImage) is all black it will match with no error because all it has to do is find black pixels and even though the input image has a white pixel, its neighbors are not white.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkImageDifference.vtkImageDifference ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

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.

virtual void Kitware.VTK.vtkImageDifference.AllowShiftOn ( ) [virtual]

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.

virtual void Kitware.VTK.vtkImageDifference.AveragingOff ( ) [virtual]

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.

virtual void Kitware.VTK.vtkImageDifference.AveragingOn ( ) [virtual]

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.

override void Kitware.VTK.vtkImageDifference.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

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.

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.

Return the total error in comparing the two images.

Return the total error in comparing the two images.

Specify the Image to compare the input to.

Here is the call graph for this function:

Specify a threshold tolerance for pixel differences.

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.

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.

override int Kitware.VTK.vtkImageDifference.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

static new int Kitware.VTK.vtkImageDifference.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkImageDifference.SetAllowShift ( int  _arg) [virtual]

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.

virtual void Kitware.VTK.vtkImageDifference.SetAveraging ( int  _arg) [virtual]

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.

Specify the Image to compare the input to.

virtual void Kitware.VTK.vtkImageDifference.SetThreshold ( int  _arg) [virtual]

Specify a threshold tolerance for pixel differences.

static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_AllowShiftOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_AllowShiftOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_AveragingOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_AveragingOn_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageDifference.vtkImageDifference_GetAllowShift_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageDifference.vtkImageDifference_GetAveraging_06 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkImageDifference.vtkImageDifference_GetError_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_GetError_08 ( HandleRef  pThis,
IntPtr  e 
) [private]
static internal IntPtr Kitware.VTK.vtkImageDifference.vtkImageDifference_GetImage_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkImageDifference.vtkImageDifference_GetThreshold_10 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkImageDifference.vtkImageDifference_GetThresholdedError_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_GetThresholdedError_12 ( HandleRef  pThis,
IntPtr  e 
) [private]
static internal int Kitware.VTK.vtkImageDifference.vtkImageDifference_IsA_13 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkImageDifference.vtkImageDifference_IsTypeOf_14 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkImageDifference.vtkImageDifference_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkImageDifference.vtkImageDifference_NewInstance_16 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkImageDifference.vtkImageDifference_SafeDownCast_17 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_SetAllowShift_18 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_SetAveraging_19 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_SetImage_20 ( HandleRef  pThis,
HandleRef  image 
) [private]
static internal void Kitware.VTK.vtkImageDifference.vtkImageDifference_SetThreshold_21 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkImageDifference.MRClassNameKey = "18vtkImageDifference" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.

new const string Kitware.VTK.vtkImageDifference.MRFullTypeName = "Kitware.VTK.vtkImageDifference"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkThreadedImageAlgorithm.


The documentation for this class was generated from the following file: