Function compareImageWithSavedImage

Wrapping/Python/vtkmodules/test/Testing.py:315–352

Compares a source image (src_img, which is a vtkImageData) with the saved image file whose name is given in the second argument. If the image file does not exist the image is generated and stored. If not the source image is compared to that of the figure. This function also handles

(src_img, img_fname, threshold=0.05)

    return None

def compareImageWithSavedImage(src_img, img_fname, threshold=0.05):
    """Compares a source image (src_img, which is a vtkImageData) with
    the saved image file whose name is given in the second argument.
    If the image file does not exist the image is generated and
    stored.  If not the source image is compared to that of the
    figure.  This function also handles multiple images and finds the
    best matching image.
    """
    global _NO_IMAGE, VTK_TEMP_DIR
    if _NO_IMAGE:
        return

    # create the testing class to do the work
    rtTester = vtkTesting()

    # Set the controller if possible
    try:
        rtTester.SetController(_GetController())
    except:
        pass

    # Add temp directory to the arguments
    if len(VTK_TEMP_DIR) != 0:
        rtTester.AddArgument("-T")
        rtTester.AddArgument(VTK_TEMP_DIR)
    # Add image file name to the arguments
    rtTester.AddArgument("-V")
    rtTester.AddArgument(img_fname)

    output_string =  reference("")
    result = rtTester.RegressionTest(src_img, threshold, output_string)

    # If the test failed, raise an exception
    if result == vtkTesting.FAILED:
        raise RuntimeError(output_string.get())
    # If the test passed, print the output
    else:
        print(output_string.get())

def compareImage(renwin, img_fname, threshold=0.05):
    """Compares renwin's (a vtkRenderWindow) contents with the image