RodTracker 0.6.5.dev1

GUI to track rod-like particles on multiple cameras

RodTracker

This package provides a GUI encapsulating the most used functionality of the ParticleDetection package. It enables users to carry out the aforementioned tasks, except for training a model. Additionally, it provides the means to manually correct placement and assignment mistakes of the automated processes.

Please refer to the documentation for more detailed information.

Installation

Refer to the documentation for more details on the installation process.

Installation as a standalone program

Use the provided executable installer for your operating system provided in the repository releases:

• RodTracker-Setup.exe - Windows
• RodTracker-Setup.deb - Linux
• RodTracker-Setup.dmg - macOS

Note: There might not always be a version provided for macOS.

Installation as a python package

Requirements:

• Python >=3.8
• pip

Install the default version using pip:

pip install RodTracker

Or use one of the options described in the documentation.

pip install RodTracker[OPTION]

Install it from source by:

1. Cloning the repository containing the RodTracker. Do NOT just copy the RodTracker folder. This will lead to a missing dependency during the installation.
2. Install it using pip.

   YOUR/REPO/PATH/RodTracker$ pip install .
   

It is also possible to install it directly from GitHub (requires Git to be installed):

pip install 'git+https://github.com/ANP-Granular/ParticleTracking.git#egg=rodtracker&subdirectory=RodTracker'

pip install 'rodtracker[DOCS] @ git+https://github.com/ANP-Granular/ParticleTracking.git#egg=RodTracker&s
ubdirectory=RodTracker'

Running the RodTracker

Run the RodTracker GUI using one of the possibilities:

• (Standalone Program) Run the executable installed by the installer.
• (Python Package) Run main.py manually:

  YOUR/REPO/PATH/RodTracker/src/RodTracker$ python main.py
  

• (Python Package) Run the GUI script entry point:

  ARBITRARY/PATH$ RodTracker
  

Keyboard shortcuts

Feature	Shortcut
Open images	Ctrl + O
Save rod position data	Ctrl + S
Switch to next/previous view	Ctrl+Tab
Zoom in/out	+/- Ctrl+Wheel
Fit image to available space	F
Show in original size	Ctrl + R
Next/previous image	Right/Left
Undo	Ctrl + Z
Lengthen/Shorten a rod	A/S
Lengthen/Shorten all rods in current view	R/T
Delete a selected rod	Del
Toggle automatic rod selection mode	G