# A humble image tracking code
![Made with Python](https://img.shields.io/badge/Made%20with-Python-blue?logo=python&logoColor=ecf0f1&labelColor=34495e)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tracking-markers?labelColor=34495e)
[![PyPI](https://img.shields.io/pypi/v/tracking-markers?labelColor=34495e)](https://pypi.org/project/tracking-markers "Go to PyPI")
![PyPI - Wheel](https://img.shields.io/pypi/wheel/tracking-markers?labelColor=34495e)
[![GitHub license](https://img.shields.io/github/license/bertoldi-collab/tracking-markers?labelColor=34495e)](https://github.com/bertoldi-collab/tracking-markers/blob/main/LICENSE)
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fbertoldi-collab%2Ftracking-markers&count_bg=%2327AE60&title_bg=%2334495E&icon=github.svg&icon_color=%23E7E7E7&title=Hits&edge_flat=false)](https://hits.seeyoufarm.com)
This is a humble image tracking code.
It is humble because it does what it can.
<p align="center">
<img width="460" height="300" src="examples/spaceman.gif">
</p>
## Installation
Intall latest version directly from PyPI with
```bash
pip install tracking-markers
```
Or install from this repository (assuming you have access to the repo and ssh keys are set up in your GitHub account) with
```bash
pip install git+ssh://git@github.com/bertoldi-collab/tracking-markers.git@main
```
Or clone the repository and install with
```bash
git clone git@github.com:bertoldi-collab/tracking-markers.git
cd tracking-markers
pip install -e .
```
## How to use
### CLI
Run in a terminal
```bash
tracking-markers path/to/video.mp4
```
See `tracking-markers --help` for more info on all the options.
### Python
The main module is [`tracking_points.py`](tracking_markers/tracking_points.py) defining the `track_points(...)` function that actually does the tracking of a given video and the function `select_markers(...)` that allows the manual selection of markers.
These functions can be used independently.
The file [`tracking_points.py`](tracking_markers/tracking_points.py) can also be used as a script.
## Some info
- It is based on the [OpenCV](https://opencv.org/) library.
- Allows for markers to be manually selected or an `np.ndarray` of markers can be loaded from a file.
- Works best on high-contrast videos.
Raw data
{
"_id": null,
"home_page": "https://github.com/bertoldi-collab/tracking-markers",
"name": "tracking-markers",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "image-tracking, opencv",
"author": "Giovanni Bordiga",
"author_email": "gbordiga@seas.harvard.edu",
"download_url": "https://files.pythonhosted.org/packages/5b/7a/510fd56a38fb0f64fc14e643f7a7c648c4c461e1fa1a8d651b3bf0d5ad66/tracking-markers-0.4.0.tar.gz",
"platform": null,
"description": "# A humble image tracking code\n\n![Made with Python](https://img.shields.io/badge/Made%20with-Python-blue?logo=python&logoColor=ecf0f1&labelColor=34495e)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tracking-markers?labelColor=34495e)\n[![PyPI](https://img.shields.io/pypi/v/tracking-markers?labelColor=34495e)](https://pypi.org/project/tracking-markers \"Go to PyPI\")\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/tracking-markers?labelColor=34495e)\n[![GitHub license](https://img.shields.io/github/license/bertoldi-collab/tracking-markers?labelColor=34495e)](https://github.com/bertoldi-collab/tracking-markers/blob/main/LICENSE)\n[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fbertoldi-collab%2Ftracking-markers&count_bg=%2327AE60&title_bg=%2334495E&icon=github.svg&icon_color=%23E7E7E7&title=Hits&edge_flat=false)](https://hits.seeyoufarm.com)\n\nThis is a humble image tracking code.\nIt is humble because it does what it can.\n\n<p align=\"center\">\n <img width=\"460\" height=\"300\" src=\"examples/spaceman.gif\">\n</p>\n\n## Installation\n\nIntall latest version directly from PyPI with\n\n```bash\npip install tracking-markers\n```\n\nOr install from this repository (assuming you have access to the repo and ssh keys are set up in your GitHub account) with\n\n```bash\npip install git+ssh://git@github.com/bertoldi-collab/tracking-markers.git@main\n```\n\nOr clone the repository and install with\n\n```bash\ngit clone git@github.com:bertoldi-collab/tracking-markers.git\ncd tracking-markers\npip install -e .\n```\n\n## How to use\n\n### CLI\n\nRun in a terminal\n\n```bash\ntracking-markers path/to/video.mp4\n```\n\nSee `tracking-markers --help` for more info on all the options.\n\n### Python\n\nThe main module is [`tracking_points.py`](tracking_markers/tracking_points.py) defining the `track_points(...)` function that actually does the tracking of a given video and the function `select_markers(...)` that allows the manual selection of markers.\nThese functions can be used independently.\nThe file [`tracking_points.py`](tracking_markers/tracking_points.py) can also be used as a script.\n\n## Some info\n\n- It is based on the [OpenCV](https://opencv.org/) library.\n- Allows for markers to be manually selected or an `np.ndarray` of markers can be loaded from a file.\n- Works best on high-contrast videos.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A humble image tracking code",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/bertoldi-collab/tracking-markers",
"Repository": "https://github.com/bertoldi-collab/tracking-markers"
},
"split_keywords": [
"image-tracking",
" opencv"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "68c67d01d774b4dfbe9bb225f6ecfbb8159ee800281ace1fbdeccfa2658e3da1",
"md5": "9000bd0334e5d2392beb1cd589b5db15",
"sha256": "74ba935d37389e3ef9921132b285339c0498319dfbe1c6e665f570708fa40a37"
},
"downloads": -1,
"filename": "tracking_markers-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9000bd0334e5d2392beb1cd589b5db15",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 7637,
"upload_time": "2024-08-06T04:08:34",
"upload_time_iso_8601": "2024-08-06T04:08:34.664996Z",
"url": "https://files.pythonhosted.org/packages/68/c6/7d01d774b4dfbe9bb225f6ecfbb8159ee800281ace1fbdeccfa2658e3da1/tracking_markers-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b7a510fd56a38fb0f64fc14e643f7a7c648c4c461e1fa1a8d651b3bf0d5ad66",
"md5": "532db7575d68a80bff880e0d70654a8d",
"sha256": "1915f51dcc08cd435eb71716a1551b085f53fa20d032733039edb215cf2bfbef"
},
"downloads": -1,
"filename": "tracking-markers-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "532db7575d68a80bff880e0d70654a8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 6855,
"upload_time": "2024-08-06T04:08:33",
"upload_time_iso_8601": "2024-08-06T04:08:33.299613Z",
"url": "https://files.pythonhosted.org/packages/5b/7a/510fd56a38fb0f64fc14e643f7a7c648c4c461e1fa1a8d651b3bf0d5ad66/tracking-markers-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 04:08:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bertoldi-collab",
"github_project": "tracking-markers",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tracking-markers"
}