Skip to content

flochkristof/motiontracker

Repository files navigation

Motion Tracker Beta

Motion Tracker Beta

An easy-to-use, standalone and open-source motion tracking application for researchers and engineers, written in Python.

Features

  • Intutitive graphical user interface
  • Capable of handling the most common video formats
  • Capable of tracking various properties of multiple objects simultaneously
  • Diverse set of built in tracking algorithms, based on the OpenCV libary
  • Rich selection of numerical differentiation algorithms powered by the PyNumDiff libary
  • Built in plotting an exporting features

For the complete list of features please check the documentation.

Dependencies

The Graphical user interface was created with the PyQt5 framework. For the handling of video files and to do the actual tracking the OpenCV library was used with its built in tracking algorithms. Numerical differentiations are carried out using the PyNumDiff. Plots and figures are generated by matplotlib. For the complete list of required packages check pyproject.toml

Installation

Prerequisites

The project requires Python 3.12. We recommend using pyenv to manage Python versions:

$ pyenv install 3.12
$ pyenv local 3.12

You also need Poetry for dependency management. You can install it with

$ pip install poetry

Download & install via PyPI (recommended)

$ pip install MotionTrackerBeta
  • Run the application
$ MotionTrackerBeta

Download & install the wheel file

  • Download the .whl file from the latest release
  • Install with pip
$ pip install <path-to-wheel-file.whl>
  • Run the application
$ MotionTrackerBeta

Run from source

  • Download the source from the latest release or clone the repository
$ git clone https://github.com/flochkristof/motiontracker.git
  • Install dependencies with poetry:
$ poetry install
  • Run the application
$ poetry run motiontracker

Download binaries (Windows)

  • Download the binaries from the latest release
  • Extract it to your specified location
  • Run application with Motion Tracker Beta.exe

Download the installer (Windows)

  • Download the installer from the latest release
  • Run the installer and follow the instructions
  • After successful installation the software is accessible under the name Motion Tracker Beta

Build standalone executable

  • Install dependencies (including dev dependencies):
$ poetry install
  • Build the executable with PyInstaller:
$ poetry run pyinstaller MotionTracker.spec
  • The executable will be in the dist/ directory

Usage

For a detailed guide about the software check out the documentation. A video that intorduces the main features and functions of the software is also available online.

License & citation

Motion Tracker Beta is released under the GNU General Public License v3.0.

If you found our software useful in your research, please cite our article:

@article{MotionTrackerBeta2023,
title = {Motion Tracker Beta: A GUI based open-source motion tracking application},
journal = {SoftwareX},
volume = {23},
pages = {101424},
year = {2023},
issn = {2352-7110},
doi = {https://doi.org/10.1016/j.softx.2023.101424},
url = {https://www.sciencedirect.com/science/article/pii/S2352711023001206},
author = {Kristóf Floch and Attila Kossa}
}

Author

The software has been developed by Kristof Floch at the Department of Applied Mechanics, Faculty of Mechanical Engineering, Budapest University of Technology and Economics.

Contact

About

An easy-to-use, standalone and open source motion tracking application for researchers

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages