Skip to main content

Image color extraction

Project description

version github python35 license format

This module uses PIL (Pillow) to extract colors from images

Available functions

average(image, name=None, downsample=True, max_size=100, alpha_threshold=None)

Averages a single image into RGB color values. Returns a dictionary with the following keys: name, red, green, blue

  • image - filename (string), pathlib.Path object or a file object. The file object must implement read(), seek(), and tell() methods, and be opened in binary mode.
  • name - auto generated from image path by calling image.split(os.sep)[-1] unless set.
  • downsample - chooses if downsampling is enabled to speed up processing. Enabled by default.
  • max_size - max length of longest side if downsample is True
  • alpha_threshold - level at which transparent pixels are excluded from the average. Default is 245

average_images(dir_in)

Averages each individual image in a directory and returns a list with an entry for each image successfully averaged. Returns a list containing a dictionary for each image with the following keys: name, red, green, blue

  • dir_in - path to directory

directory_average(dir_in, name=None)

Averages all images in a directory to a singular RGB directory average. Returns a dictionary with the following keys: name, red, green, blue

  • dir_in - path to directory
  • name - auto generated from directory path by calling dir_in.split(os.sep)[-1] unless set.

nested_directory_average(root_dir)

Accepts the path to a directory and walks all the enclosed directories calling average_directory for each one that contains images. Returns a list containing a dictionary for each directory with the following keys: name, red, green, blue

  • root_dir - path to starting directory

Future work

  • add usage examples to readme
  • add information for loadsave functions to readme

Tests

Testing is done with pytest

Run with python3 setup.py test

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 imagecolor, version 1.2.1
Filename, size File type Python version Upload date Hashes
Filename, size imagecolor-1.2.1-py3-none-any.whl (10.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size imagecolor-1.2.1.tar.gz (6.9 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