Skip to content

kaindoh/ColorDetect

 
 

Repository files navigation

ColorDetect

ColorDetect
Documentation | Package

ColorDetect

PyPI version CircleCI Downloads Documentation Status

ColorDetect works to recognize and identify different colors in an image or video.

Installation

pip install ColorDetect

Basic Usage

Images

from colordetect import ColorDetect


user_image = ColorDetect(<path_to_image>)
# return dictionary of color count. Do anything with this
user_image.get_color_count()

# write color count
user_image.write_color_count()
# optionally, write any text to the image
user_image.write_text(text="any text")

# save the image after using either of the options (write_color_count/write_text) or both
user_image.save_image(<storage_path>,<image_name>)

Resultant image is stored in the string storage_path of choice with the image_name which will default to the current location and out.jpg respectively by default.

Videos

from colordetect import VideoColor

user_video = VideoColor(<path_to_video>)
# return dictionary of color count. Do anything with this result
user_video.get_video_frames()
# to order this rather long result and get only a specific number
user_video.color_sort(color_count=6)

Project Documentation

For further project documentation, visit ColorDetect's page

Contributions

Contributions are welcome. Do remember to take a look at the project contribution guidelines

Tests

To run tests:

pytest 

About

Detect and identify different color objects in an image/video

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Python 100.0%