Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thephpleague/color-extractor
Extract colors from an image like a human would do.
https://github.com/thephpleague/color-extractor
Last synced: 25 days ago
JSON representation
Extract colors from an image like a human would do.
- Host: GitHub
- URL: https://github.com/thephpleague/color-extractor
- Owner: thephpleague
- License: mit
- Created: 2013-07-19T09:38:35.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-11-02T19:34:55.000Z (about 1 year ago)
- Last Synced: 2024-05-22T10:42:08.680Z (6 months ago)
- Language: PHP
- Homepage: thephpleague.com
- Size: 759 KB
- Stars: 1,286
- Watchers: 31
- Forks: 159
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php - Color Extractor - A library for extracting colours from images. (Table of Contents / Imagery)
- awesome-projects - Color Extractor - A library for extracting colours from images. (PHP / Imagery)
- php-awesome - ColorExtractor - 获取图片中的颜色 (类库 / 图像处理)
- awesome-php - Color Extractor - A library for extracting colours from images. (Table of Contents / Imagery)
- awesome-php-cn - Color Extractor - 从图像中提取颜色的图书馆. (目录 / 图像 Imagery)
README
ColorExtractor
==============
[](https://packagist.org/packages/league/color-extractor)
[](https://packagist.org/packages/league/color-extractor)
Extract colors from an image like a human would do.
## Install
Via Composer
``` bash
$ composer require league/color-extractor
```
## Usage
```php
require 'vendor/autoload.php';
use League\ColorExtractor\Color;
use League\ColorExtractor\ColorExtractor;
use League\ColorExtractor\Palette;
$palette = Palette::fromFilename('./some/image.png');
// $palette is an iterator on colors sorted by pixel count
foreach($palette as $color => $count) {
// colors are represented by integers
echo Color::fromIntToHex($color), ': ', $count, "\n";
}
// it offers some helpers too
$topFive = $palette->getMostUsedColors(5);
$colorCount = count($palette);
$blackCount = $palette->getColorCount(Color::fromHexToInt('#000000'));
// an extractor is built from a palette
$extractor = new ColorExtractor($palette);
// it defines an extract method which return the most “representative” colors
$colors = $extractor->extract(5);
```
## Handling transparency
By default **any pixel with alpha value greater than zero will be discarded**. This is because transparent colors are not perceived
as is. For example fully transparent black would be seen white on a white background. So if you want to take transparency into account
when building a palette you have to specify this background color. You can do this with the second argument of `Palette` constructors.
Its default value is `null`, meaning a color won't be added to the palette if its alpha component exists and is greater than zero.
You can set it as an integer representing the color, then transparent colors will be blended before addition to the palette.
```php
// we set a white background so fully transparent colors will be added as white in the palette
// pure red #FF0000 at 50% opacity will be stored as #FF8080 as it would be perceived
$palette = Palette::fromFilename('./some/image.png', Color::fromHexToInt('#FFFFFF'));
```
## Contributing
Please see [CONTRIBUTING](https://github.com/thephpleague/color-extractor/blob/master/CONTRIBUTING.md) for details.
## Credits
- [Mathieu Lechat](https://github.com/MatTheCat)
- [All Contributors](https://github.com/thephpleague/color-extractor/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/thephpleague/color-extractor/blob/master/LICENSE) for more information.