https://github.com/marvinkweyu/colordetect
Image processing: Detect and identify different color objects in an image/video
https://github.com/marvinkweyu/colordetect
color color-count color-recognition colordetect colorrecognition detection image-processing opencv python
Last synced: 8 months ago
JSON representation
Image processing: Detect and identify different color objects in an image/video
- Host: GitHub
- URL: https://github.com/marvinkweyu/colordetect
- Owner: MarvinKweyu
- License: mit
- Created: 2019-05-04T11:40:29.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-21T18:14:32.000Z (almost 2 years ago)
- Last Synced: 2025-02-10T00:04:38.318Z (over 1 year ago)
- Topics: color, color-count, color-recognition, colordetect, colorrecognition, detection, image-processing, opencv, python
- Language: Python
- Homepage: https://pypi.org/project/ColorDetect/
- Size: 7.41 MB
- Stars: 22
- Watchers: 3
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
# ColorDetect
ColorDetect
Documentation |
Package
[](https://pypi.org/project/ColorDetect/)
[](https://pypi.org/project/ColorDetect/)
[](https://pypi.org/project/ColorDetect/)
[](https://colordetect.readthedocs.io/en/master/)
> ColorDetect works to recognize and identify different colors in an image or video.
## Installation
```bash
pip install ColorDetect
```
## Basic Usage
### Images
```python
from colordetect import ColorDetect
user_image = ColorDetect()
# 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(,)
```
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
```python
from colordetect import VideoColor,col_share
user_video = VideoColor()
# return dictionary of color count. Do anything with this result
user_video.get_video_frames(progress=True)
# to order this rather long result and get only a specific number look up the `col_share` module
```
You can also get colors at a specific time and extract the frame at that given time.
## Project Documentation
For further project documentation, visit [ColorDetect's page](https://colordetect.readthedocs.io/en/latest/)
## Contributions
Contributions are welcome.
Do remember to take a look at the project [contribution guidelines](https://github.com/MarvinKweyu/ColorDetect/blob/master/CONTRIBUTING.rst)
### Tests
To run tests:
```bash
pytest
```
### Pre-commit
Pre-commit hooks are used to automate linting
1. Install the git hook scripts
```shell
pre-commit install
```
1. (optional) Run against all the files
```shell
pre-commit run --all-files
```
The installed pre-commit hooks will automatically ensure use of a consistent code format and style whenever one commits
changes using git. For full documentation, view the [pre-commit docs](https://pre-commit.com/).
## Hall of Code
To the amazing human beings and developers that made this possible.
