undemanding/difference

Calculate the difference in images

1.1.0 2016-05-15 03:33 UTC

Requires

• php: ^5.6|^7.0

Requires (Dev)

• phpunit/phpunit: ^5.3

MIT

README

Calculate the difference in images.

Usage

use Undemanding\Difference\Image;
use Undemanding\Difference\Method\EuclideanDistance;

$image1 = new Image("/path/to/image1.png");
$image2 = new Image("/path/to/image2.png");

$difference = $image1->difference($image2, new EuclideanDistance());

$boundary = $difference->boundary(); // → ["left" => ..., "top" => ...]
$percentage = $difference->percentage(); // → 14.03...

You can ignore smaller changes by scaling and/or reducing the differences by a standard deviation:

$difference->withScale(10)->withReducedStandardDeviation();

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.