Skip to main content

A python package for decomposing an image into basic colours

Project description

Color-extraction

Color-extraction is an open-source python module which attributes to each element of an ndarray (RGB image) the most similar color from a palette of predefined colors.

Three functions are included, each of which takes an RGB ndarray as input and returns a dict whose keys are the names of each predefined color:

Function Values of returned dict
get_bool_arrays boolean ndarrays (1 per color)
get_rgb_arrays RGB ndarrays (1 per color)
get_counts integer counts of pixels (1 per color)

Installing

>>> pip install color_extraction

Usage examples

A predefined set of colors is included in the module with ten colors: red, orange, yellow, green, cyan, blue, purple, pink, achromatic (gray and black), and white. This set of colors, which can be modified, is available at https://github.com/ChrisCocco/ddd_colours/blob/master/color_extraction/color_definitions.json.

To get started:

>>> import color_extraction
>>> import matplotlib
>>> import matplotlib.pyplot

>>> with matplotlib.cbook.get_sample_data('ada.png') as image_file:
... img = matplotlib.pyplot.imread(image_file)

Boolean arrays

The function get_bool_arrays returns a dictionary with a boolean ndarray for each color. Each such array has the same horizontal and vertical dimensions as the source image and can be thought of as a mask for the color in question.

>>> dict_bool_arrays = color_extraction.get_bool_arrays(img)

>>> for color in dict_bool_arrays.keys():
    matplotlib.image.imsave(output_path + color + ".png", dict_bool_arrays[color], cmap='gray')
Original image white red orange
Original image White Red Orange
yellow green cyan blue
Yellow Green Cyan Blue
purple pink achromatic
Purple White Achromatic

It is also possible to use a median filter (3 x 3) in order to reduce the amount of pixels of a given color that are isolated in the array:

>>> color_extraction.get_bool_arrays(img, median_filter=True)

It is also possible to use your own color definitions saved in a JSON file.

>>> color_extraction.get_bool_arrays(img, color_def_path=path_to_your_json_file)

RGB arrays

The function get_rgb_arrays returns a dictionary with a RGB array for each color. Each such array has the same horizontal and vertical dimensions as the source image. Positions where the color in question has been detected contain the original RGB color found in the source image; other positions have the value 0 (black), except in the case of the "achro(matic)" color, where they have the value 1 (white).

>>> dict_rgb_arrays = color_extraction.get_rgb_arrays(img)

>>> for color in dict_rgb_arrays:
... matplotlib.image.imsave(color, dict_rgb_arrays[color])

Using the following image as input:

Original image white red orange
Original image White Red Orange
yellow green cyan blue
Yellow Green Cyan Blue
purple pink achromatic
Purple White Achromatic

Similarly to get_bool_arrays, it is possible to use a median filter and/or your own color definition set, with the same parameters (median_filter and color_def_path).

Pixel counts

The function get_counts returns a dictionary with the number of pixels of each colour.

>>> color_extraction.get_counts(img)
{'purple': 25, 'blue': 6652, 'achro': 2477505, 'cyan': 764, 'white': 9567, 'green': 185, 'red': 114555, 'pink': 163, 'orange': 150263, 'yellow': 5121}

Similarly to get_bool_arrays, it is possible to use your own color definition set, with the same parameter (color_def_path). The median filter is not available for this function.

Dependencies

  • scipy.cluster.vq
  • skimage.filters
  • numpy

Authors

Credits

This module was partially funded by the the Swiss National Science Foundation (SNSF), grant N° CR11I1_156383.

The current version (0.1a4) was implemented by Aris Xanthos based on the original code by Christelle Cocco available here.

To cite: Cocco, C., Ceré, R., Xanthos, A., Brandt, P.-Y. 2019. Identification and quantification of colours in children's drawings. Workshop on Computational Methods in the Humanities 2018. pp. 11-21. Vol. 2314. CEUR Workshop Proceedings

License

This project is licensed under the GNU General Public License v3 - see the LICENSE file for details.

Acknowledgements

Witold KupÅ›, mihirm3hub

Project details


Download files

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

Files for color-extraction, version 0.1a4
Filename, size File type Python version Upload date Hashes
Filename, size color_extraction-0.1a4-py3-none-any.whl (21.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size color_extraction-0.1a4.tar.gz (8.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page