# A humble image tracking code
![Made with Python](https://img.shields.io/badge/Made%20with-Python-blue?logo=python&logoColor=ecf0f1&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
Assuming you have access to the repo and ssh keys are set up in your GitHub account, you can install the package with
```bash
pip install git+ssh://git@github.com/bertoldi-collab/tracking-markers.git@main
```
## 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/43/09/bceac71b09664407d1dba7b9965640a7cafeef41ae12a857340d6cb65278/tracking-markers-0.2.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[![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\nAssuming you have access to the repo and ssh keys are set up in your GitHub account, you can install the package with\n\n```bash\npip install git+ssh://git@github.com/bertoldi-collab/tracking-markers.git@main\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.2.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": "b15de934e57ad88a6aa9d0bb4e5fdf04932de264940093bfc6afede02850043b",
"md5": "fa36dbc0c655ba4040e566d92d559d07",
"sha256": "4a23022e99ee32e0504887de725193f0e717d63f56a3293baf03f42996e767d8"
},
"downloads": -1,
"filename": "tracking_markers-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa36dbc0c655ba4040e566d92d559d07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 7472,
"upload_time": "2024-05-01T03:09:19",
"upload_time_iso_8601": "2024-05-01T03:09:19.709538Z",
"url": "https://files.pythonhosted.org/packages/b1/5d/e934e57ad88a6aa9d0bb4e5fdf04932de264940093bfc6afede02850043b/tracking_markers-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4309bceac71b09664407d1dba7b9965640a7cafeef41ae12a857340d6cb65278",
"md5": "3ef055a21c95dcfd11d6b449bc5213aa",
"sha256": "d1840ef752f8744111a8779486c8193596dd93e455e9f752a7326ae5ed9d26db"
},
"downloads": -1,
"filename": "tracking-markers-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3ef055a21c95dcfd11d6b449bc5213aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 6631,
"upload_time": "2024-05-01T03:09:18",
"upload_time_iso_8601": "2024-05-01T03:09:18.058588Z",
"url": "https://files.pythonhosted.org/packages/43/09/bceac71b09664407d1dba7b9965640a7cafeef41ae12a857340d6cb65278/tracking-markers-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 03:09:18",
"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"
}