capsulescodes/laravel-dominant-color

Find dominant colors in an image using K-means clustering

0.3 2023-05-03 14:25 UTC

Requires

• php: ^8.1
• bdelespierre/php-kmeans: v2.2.0
• illuminate/contracts: ^9.0 || ^10.0
• illuminate/support: ^9.0 || ^10.0
• spatie/laravel-package-tools: ^1.13.7

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^6.0
• nunomaduro/larastan: ^2.0.1
• orchestra/testbench: ^7.0
• pestphp/pest: ^1.21
• pestphp/pest-plugin-laravel: ^1.1
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^9.5
• spatie/laravel-ray: ^1.26

MIT

• naomai
• dib258

README

This laravel package is made from a fork of naomi/php-dominantcolor repository

This laravel package extracts dominant colors from images - those, which are most likely to attract the viewer's eyes.

The library uses K-means clustering method to group image pixels into different color bins. Those colors are then evaluated by their saturation and differences between others. Two of them are picked as most prominent (primary and secondary).

Requirements

• PHP 8 or higher
• Laravel 8 or higher

Installation

Install the package in your application by running

composer require capsulescodes/laravel-dominant-color

Usage

We want to find most prominent colors with three additional colors from image heart.png.

You can acces the DominantColor via Facade like the following :

$imageSrc = "heart.png";
$totalNumberOfColors = 5; // primary + secondary + 3 additional

DominantColor::fromFile($imageSrc, $totalNumberOfColors);

Number of colors is the number of color bins, it also should include primary and secondary colors.

The result is an array of following structure:

$colorInfo = [
	'primary' => 0xDEFDEF,
	'secondary' => 0xABCABC,
	'palette' => [
		0 => ['color' => 0xABCABC, 'score' => 0.8],
		/// etc
	];

All colors are formatted as standard RGB integer in form: 0xRRGGBB.

palette contains additional colors. The score field is a score from secondary color choosing algorithm. The chosen secondary color has value of 1.0.

See examples directory for a visual demonstration.

This project relies on the elegant PHP K-Means library by Benjamin Delespierre.