Skip to content

fooImage -> foo_image in testing/compare.py #12877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 30, 2018
Merged

fooImage -> foo_image in testing/compare.py #12877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/api/next_api_changes/2018-11-24-AL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
API changes
```````````
The arguments of `matplotlib.testing.compare.calculate_rms` have been renamed
from ``expectedImage, actualImage``, to ``expected_image, actual_image``.

Deprecations
````````````
The ``matplotlib.testing.decorators.switch_backend`` decorator is deprecated.
Test functions should use ``pytest.mark.backend(...)``, and the mark will be
picked up by the ``matplotlib.testing.conftest.mpl_test_settings`` fixture.
50 changes: 25 additions & 25 deletions lib/matplotlib/testing/compare.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,14 +352,14 @@ def crop_to_same(actual_path, actual_image, expected_path, expected_image):
return actual_image, expected_image


def calculate_rms(expectedImage, actualImage):
def calculate_rms(expected_image, actual_image):
"Calculate the per-pixel errors, then compute the root mean square error."
if expectedImage.shape != actualImage.shape:
if expected_image.shape != actual_image.shape:
raise ImageComparisonFailure(
"Image sizes do not match expected size: {} "
"actual size {}".format(expectedImage.shape, actualImage.shape))
"actual size {}".format(expected_image.shape, actual_image.shape))
# Convert to float to avoid overflowing finite integer types.
return np.sqrt(((expectedImage - actualImage).astype(float) ** 2).mean())
return np.sqrt(((expected_image - actual_image).astype(float) ** 2).mean())


def compare_images(expected, actual, tol, in_decorator=False):
Expand Down Expand Up @@ -428,26 +428,26 @@ def compare_images(expected, actual, tol, in_decorator=False):
expected = convert(expected, True)

# open the image files and remove the alpha channel (if it exists)
expectedImage = _png.read_png_int(expected)
actualImage = _png.read_png_int(actual)
expectedImage = expectedImage[:, :, :3]
actualImage = actualImage[:, :, :3]
expected_image = _png.read_png_int(expected)
actual_image = _png.read_png_int(actual)
expected_image = expected_image[:, :, :3]
actual_image = actual_image[:, :, :3]

actualImage, expectedImage = crop_to_same(
actual, actualImage, expected, expectedImage)
actual_image, expected_image = crop_to_same(
actual, actual_image, expected, expected_image)

diff_image = make_test_filename(actual, 'failed-diff')

if tol <= 0:
if np.array_equal(expectedImage, actualImage):
if np.array_equal(expected_image, actual_image):
return None

# convert to signed integers, so that the images can be subtracted without
# overflow
expectedImage = expectedImage.astype(np.int16)
actualImage = actualImage.astype(np.int16)
expected_image = expected_image.astype(np.int16)
actual_image = actual_image.astype(np.int16)

rms = calculate_rms(expectedImage, actualImage)
rms = calculate_rms(expected_image, actual_image)

if rms <= tol:
return None
Expand Down Expand Up @@ -481,21 +481,21 @@ def save_diff_image(expected, actual, output):
File path to save difference image to.
'''
# Drop alpha channels, similarly to compare_images.
expectedImage = _png.read_png(expected)[..., :3]
actualImage = _png.read_png(actual)[..., :3]
actualImage, expectedImage = crop_to_same(
actual, actualImage, expected, expectedImage)
expectedImage = np.array(expectedImage).astype(float)
actualImage = np.array(actualImage).astype(float)
if expectedImage.shape != actualImage.shape:
expected_image = _png.read_png(expected)[..., :3]
actual_image = _png.read_png(actual)[..., :3]
actual_image, expected_image = crop_to_same(
actual, actual_image, expected, expected_image)
expected_image = np.array(expected_image).astype(float)
actual_image = np.array(actual_image).astype(float)
if expected_image.shape != actual_image.shape:
raise ImageComparisonFailure(
"Image sizes do not match expected size: {} "
"actual size {}".format(expectedImage.shape, actualImage.shape))
absDiffImage = np.abs(expectedImage - actualImage)
"actual size {}".format(expected_image.shape, actual_image.shape))
abs_diff_image = np.abs(expected_image - actual_image)

# expand differences in luminance domain
absDiffImage *= 255 * 10
save_image_np = np.clip(absDiffImage, 0, 255).astype(np.uint8)
abs_diff_image *= 255 * 10
save_image_np = np.clip(abs_diff_image, 0, 255).astype(np.uint8)
height, width, depth = save_image_np.shape

# The PDF renderer doesn't produce an alpha channel, but the
Expand Down
1 change: 1 addition & 0 deletions lib/matplotlib/testing/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,6 +487,7 @@ def _image_directories(func):
return str(baseline_dir), str(result_dir)


@cbook.deprecated("3.1", alternative="pytest.mark.backend")
def switch_backend(backend):

def switch_backend_decorator(func):
Expand Down