mikkab / color-thief-php

Grabs the dominant color or a representative color palette from an image. Uses PHP and GD.

#Color Thief PHP

A PHP class for grabbing the color palette from an image. Uses PHP and GD library to make it happen.

It's a PHP port of the [Color Thief Javascript library] (http://github.com/lokesh/color-thief), using the MMCQ (modified median cut quantization) algorithm from the [Leptonica library] (http://www.leptonica.com/).

##How to use

###Get the dominant color from an image

include "color-thief-php/ColorThiefPHP.php";
$dominantColor = ColorThiefPHP::getColor($sourceImage);

The $sourceImage variable must contain either the path (relative or absolute) of the image on the server, or a URL to the image.

ColorThiefPHP::getColor($sourceImage[, $quality=10]) 
returns array(r: num, g: num, b: num)

This function returns an array of three integer values, corresponding to the RGB values (Red, Green & Blue) of the dominant color.

You can pass an additional argument ($quality) to adjust the calculation accuracy of the dominant color. 1 is the highest quality settings, 10 is the default. But be aware that there is a trade-off between quality and speed/memory consumption ! If the quality settings are too high (close to 1) relative to the image size (pixel counts), it may exceed the memory limit set in the PHP configuration (and computation will be slow).

###Build a color palette from an image

In this example, we build an 8 color palette.

include "color-thief-php/ColorThiefPHP.php";
$palette = ColorThiefPHP::getPalette($sourceImage, 8)

Again, the $sourceImage variable must contain either the path (relative or absolute) of the image on the server, or a URL to the image.

ColorThiefPHP::getPalette($sourceImage[, $colorCount=10, $quality=10])
returns array(array(num, num, num), array(num, num, num), ... )

The $colorCount argument determines the size of the palette; the number of colors returned. If not set, it defaults to 10.

The $quality argument works as in the previous function.

##Credits and license

###Author by Kevin Subileau
kevinsubileau.fr

Based on the fabulous work done by Lokesh Dhakar
lokeshdhakar.com
twitter.com/lokesh

###Thanks

• Lokesh Dhakar - For creating the original project.
• Nick Rabinowitz - For creating quantize.js.

###License Licensed under the Creative Commons Attribution 2.5 License

• Free for use in both personal and commercial projects.
• Attribution requires leaving author name, author homepage link, and the license info intact.