Package: pixelmatch
pixelmatch-pyA fast pixel-level image comparison library, originally created to compare screenshots in tests.
Now with additional support of PIL.Image instances
Python port ofhttps://github.com/mapbox/pixelmatch.Features accurateanti-aliased pixels detectionandperceptual color difference metrics.frompixelmatchimportpixelmatchnum_diff_pixels=pixelmatch(img1,img2,800,600,diff,threshold=0.1)Implements ideas from the following papers:Measuring perceived color difference using YIQ NTSC transmission color space in mobile applications(2010, Yuriy Kotsarenko, Fernando Ramos)Anti-aliased pixel and intensity slope detector(2009, Vytautas Vyšniauskas)Installpython-mpipinstallpixelmatchExample usagePIL.Image comparisonfromPILimportImagefrompixelmatch.contrib.PILimportpixelmatchimg_a=Image.open("a.png")img_b=Image.open("b.png")img_diff=Image.new("RGBA",img_a.size)# note how there is no need to specify dimensionsmismatch=pixelmatch(img_a,img_b,img_diff,includeAA=True)img_diff.save("diff.png")Raw Image Data Comparisonfrompixelmatchimportpixelmatchwidth,height=1920,1080img_a=[R1,G1,B1,A1,R2,B2,G2,A2,...]img_b=[R1,G1,B1,A1,R2,B2,G2,A2,...]data_diff=[0]*len(img_a)mismatch=pixelmatch(img_a,img_b,width,height,data_diff,includeAA=True)APIpixelmatch(img1, img2, width, height, output, threshold, includeAA, alpha, aa_color, diff_color, diff_mask, fail_fast)img1,img2— RGBA Image data of the images to compare.Note:image dimensions must be equal.width,height— Width and height of the images.output— Image data to write the diff to, orNoneif don't need a diff image. Note thatall three imagesneed to have the same dimensions.threshold— Matching threshold, ranges from0to1. Smaller values make the comparison more sensitive.0.1by default.includeAA— Iftrue, disables detecting and ignoring anti-aliased pixels.falseby default.alpha— Blending factor of unchanged pixels in the diff output. Ranges from0for pure white to1for original brightness.0.1by default.aa_color— The color of anti-aliased pixels in the diff output in[R, G, B]format.[255, 255, 0]by default.diff_color— The color of differing pixels in the diff output in[R, G, B]format.[255, 0, 0]by default.diff_mask— Draw the diff over a transparent background (a mask), rather than over the original image. Will not draw anti-aliased pixels (if detected).fail_fast- If true, will return after first different pixel.Compares two images, writes the output diff and returns the number of mismatched pixels.contrib.PIL.pixelmatchCompares two images, writes the output diff and returns the number of mismatched pixels. Exact same API aspixelmatch.pixelmatchexcept for the important fact that it takes instances of PIL.Image for image parameters (img1,img2, andoutput) and the width/size need not be specified.Example outputexpectedactualdiffChangelogv0.3.0feat: add fail_fast option#144v0.2.4type: fix typing issueschore: test Python 3.10v0.2.3feat: make package comply with PEP-561v0.2.2typing: useSequenceinstead ofListforRGBTuplebuild: switch topoetry_core#81v0.2.1feat: add function to compare PIL.Image instances through contrib.PIL.pixelmatch#42v0.2.0BREAKING CHANGE: removeoptionsparameter#38docs: use absolute url for images in READMEv0.1.1fix: fix bug in fast path#18v0.1.0Initial release