Skip to content
Permalink
Browse files

Update README.md

  • Loading branch information...
gaborvecsei committed Oct 9, 2018
1 parent cfe0485 commit 4d776ce2a3544cd5f9e00a9bd07da9efc65890fa
Showing with 36 additions and 29 deletions.
  1. +36 −29 README.md
@@ -1,58 +1,65 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/67f0a9e168b3457385f2f7fcd09a9afa)](https://www.codacy.com/app/vecseigabor.x/Color-Tracker?utm_source=github.com&utm_medium=referral&utm_content=gaborvecsei/Color-Tracker&utm_campaign=Badge_Grade)
[![PyPI version](https://badge.fury.io/py/color-tracker.svg)](https://badge.fury.io/py/color-tracker)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3](https://img.shields.io/badge/Python-3-brightgreen.svg)](https://www.python.org/downloads/)

# Color Tracker
# Color Tracker - Multi Object Tracker

Easy to use color tracking package for object tracking based on colors :art:
Easy to use **multi object tracking** package based on colors :art:

## Samples

<p align="center">
<img src="art/yellow_cruiser.gif" width="480" alt="yellow-cruiser"></a><br/>
<img src="art/ball_tracking.gif" width="480" alt="ball-tracking"></a><br/>
</p>
<img src="art/yellow_cruiser.gif" width="400" alt="yellow-cruiser"></a> <img src="art/ball_tracking.gif" width="400" alt="ball-tracking"></a>

## Install

- Python3
- OpenCV>=3
- NumPy

```
pip install color-tracker
```

## Usage
You will need the following packages:
- OpenCV3 (`pip install opencv-python`)
- Numpy (`pip install numpy`)

- Basic usage:
## Object Tracker

``` python
import cv2
import color_tracker
- Check out the **[examples folder](examples)**, or go straight to the **[sample tracking app](examples/tracking.py)** which is an extended version of the script below
``` python
python examples/tracking.py
```
- Simple script:

``` python
import cv2
import color_tracker
def tracker_callback(t: color_tracker.ColorTracker):
cv2.imshow("debug", t.debug_frame)
cv2.waitKey(1)
def tracker_callback(t: color_tracker.ColorTracker):
cv2.imshow("debug", t.debug_frame)
cv2.waitKey(1)
tracker = color_tracker.ColorTracker(max_nb_of_objects=1, max_nb_of_points=20, debug=True)
tracker.set_tracking_callback(tracker_callback)
with color_tracker.WebCamera() as cam:
# Define your custom Lower and Upper HSV values
tracker.track(cam, [155, 103, 82], [178, 255, 255], max_skipped_frames=24)
```
tracker = color_tracker.ColorTracker(max_nb_of_objects=1, max_nb_of_points=20, debug=True)
tracker.set_tracking_callback(tracker_callback)
Check out the [examples folder](examples), or go straight to the [sample tracking app](examples/tracking.py) which is an extended
version of the script above
with color_tracker.WebCamera() as cam:
# Define your custom Lower and Upper HSV values
tracker.track(cam, [155, 103, 82], [178, 255, 255], max_skipped_frames=24)
```

## Color Range Detection

This is a tool which you can use to easily determine the necessary *HSV* color values and kernel sizes for you app

You can find [the code here](examples/hsv_color_detector.py)
You can find **[the HSV Color Detector code here](examples/hsv_color_detector.py)**

``` python
python examples/hsv_color_detector.py
```

## Donate :coffee:

If you feel like it is a **useful package** and it **saved you time and effor**, then you can donate a coffe for me, so I can keep on staying awake for days :smiley:

<a href='https://ko-fi.com/A0A5KN4E' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi5.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
## About

0 comments on commit 4d776ce

Please sign in to comment.
You can’t perform that action at this time.