ℹ️ For GraphicsMagick version please see tag v0.2.1.
Extracts colour palettes from photos using k-means clustering in LAB colour space.
Is as simple as with any other Node.js module:
$ npm install @colour-extractor/colour-extractor
Note: This module contains native Rust libraries. Please open an issue if your platform isn't supported.
colour-extractor exports two functions:
const { topColours, topColoursHex } = require('@colour-extractor/colour-extractor');
const colours = await topColours('./photos/cats/tigre.jpg');
console.log(colours);
// => [ [158, 64, 75], ... ]topColours function needs a path to your image (see below for supported formats) and it resolves to an Array containing RGB triplet for each prominent colour:
[
[46, 70, 118],
[0, 0, 2],
[12, 44, 11]
]topColoursHex on the other hand returns hex codes (with # included):
const hexColours = await topColoursHex('./photos/cats/tigre.jpg');
console.log(hexColours);
// => ["#2e4676", "#000002", "#0c2c0b"]All major image formats are supported, including PNG, JPG and WebP. Please see image-rs's documentation for a full list. Note that file extension is used for determining the image type.
Here's the simplified algorithm:
- Image is scaled down to 48x48px with a fast nearest-neighbour algorithm.
- Colours are grouped into up to 16 clusters using k-means clustering.
- Identified clusters are further refined using CIEDE2000 colour distance, removing any duplicates.
colour-extractor is published under MIT license.
Photos used the examples above can be found on Unsplash: