Skip to main content

Extract colors from an image. Colors are grouped based on visual similarities using the CIE76 formula.

Project description

Command-line tool to extract colors from an image. The result will presented in two formats, text and image.

The text result will provide the usage of each color in the number of pixels and percentage. While the image will provide a palette for a visual representation.

1 Installation

1.1 Package

$ pip install extcolors

1.2 Manually

  1. Download repository as zip.

  2. Unpack zip into folder.

  3. Enter folder.

  4. Run the following command:

    $ pip install .

2 Usage

2.1 Input - Console

To use the application provide a path to the image that the application should extract colors from. In the following example the image is in the folder we are executing the command and the name of the image is gameboy.png:

$ extcolors gameboy.png

In this example gameboy.png refers to the following image created by Rebecca Machamer.

http://cairns.se/extcolors/gameboy.png

2.2 Input - Script

To use the application provide a path to the image that the application should extract colors from. In the following example the image is in the folder we are executing the command and the name of the image is gameboy.png:

>>> import extcolors
>>> colors, pixel_count = extcolors.extract("gameboy.png")
>>> print(colors)
[((0, 172, 170), 386062), ((245, 245, 245), 59559), ((82, 90, 92), 17824), ((102, 184, 52), 15080), ((236, 27, 111), 1302), ((255, 180, 0), 137), ((241, 148, 185), 36)]

2.3 Output - Text

When the application is done it will output information about the execution. Probably the most relevant information is the [RESULT]-section that contains the extracted colors in RGB values and their occurrence rate presented in percentages.

Output based on gameboy.png:

Extracted colors:
(0, 172, 170)  :  80.43% (386062)
(245, 245, 245):  12.41% (59559)
(82, 90, 92)   :   3.71% (17824)
(102, 184, 52) :   3.14% (15080)
(236, 27, 111) :   0.27% (1302)
(255, 180, 0)  :   0.03% (137)
(241, 148, 185):   0.01% (36)

Pixels in output: 480000 of 480000

2.4 Output - Image

When the application is done it will also create an image in the directory where the command was executed. The image will contain the colors that where extracted sorted based on their occurrence rate, wrapping from from left to right. The image will use the name of the original image appended with a time stamp of when the execution took place.

Output based on gameboy.png:

http://cairns.se/extcolors/gameboy-result-default.png

3 Additional Options

Generated output from the command-line argument extcolors --help.

usage: extcolors [-h] [--version] [-t [N]] [-l [N]] PATH

Extract colors from a specified image. Colors are grouped based on visual
similarities using the CIE76 formula.

positional arguments:
  PATH

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -t [N], --tolerance [N]
                        group colors to limit the output and give a better
                        visual representation. Based on a scale from 0 to 100.
                        Where 0 won't group any color and 100 will group all
                        colors into one. Defaults to 32
  -l [N], --limit [N]   upper limit to the number of extracted colors
                        presented in the output
  -o {all,image,text}, --output {all,image,text}
                        format(s) that the extracted colors should presented
                        in

4 Known Issues

4.1 Performance

When an image contains a large amount of different colors, which most do, the performance slows to a halt. If the grouping of colors is not desired/required then a workaround is to set the tolerance levels to zero. Setting the tolerance to specifically zero will make the application skip any comparisons from being made and become a simple counter resulting in much greater speeds.

Example, an image (3840x2160) containing about 340k unique colors will take two hours to complete with a tolerance level of 32 (the default value). However with a tolerance level of zero it will take ten seconds.

4.2 Adobe RGB Color Space Not Supported

Currently only the sRGB color space is supported when converting to CIE L*a*b*. Which means that grouped colors might not visual match as one would expect.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

extcolors-0.1.1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

extcolors-0.1.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file extcolors-0.1.1.tar.gz.

File metadata

  • Download URL: extcolors-0.1.1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for extcolors-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d26c39676a3c1c9da8bcc40925bca241f4cb3067ea08f8fd4b1f0fa235677dd1
MD5 3fe08b23ac5b1d0621942b4bf2f3c389
BLAKE2b-256 c7998d1b2661c9915f0b31eb15f034dc6a93b0806a4519f27110bd23a41ec28f

See more details on using hashes here.

File details

Details for the file extcolors-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: extcolors-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for extcolors-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef1f24325740b562b809f9a37524dd48413ede7ce2f1323694ab7e70bf5e5a92
MD5 3111914af9632434260e4c41f9bfd911
BLAKE2b-256 f0b609d7b06f53b2591da599f0e4f37c7ee3ca83f7e29468a4756b8f6618bcda

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page