Skip to main content

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
    

RodTracker - GUI

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

Metadata

Release files for RodTracker 0.6.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for RodTracker 0.6.7
File Size Uploaded
rodtracker-0.6.7.tar.gz 12.9 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for RodTracker 0.6.7
File Interpreter ABI Platform
rodtracker-0.6.7-py3-none-any.whl Python 3 none any Details

Total release size: 25.8 MB

Release files / rodtracker-0.6.7.tar.gz

Download URL rodtracker-0.6.7.tar.gz
Size 12.9 MB
Tags Source
SHA-256 checksum
How to use checksums
2ba51eac03e1032f32bf794cbbd8a935849c7455e940414483ae3edde22e1145
BLAKE2b-256 checksum
How to use checksums
009425f4177c5a9fcb6605a6a7fd50c03aca8311563ad1c86e0c904926db7a16
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.2 CPython/3.12.10 Linux/6.8.0-1021-azure

Release files / rodtracker-0.6.7-py3-none-any.whl

Download URL rodtracker-0.6.7-py3-none-any.whl
Size 12.9 MB
Tags Python 3
SHA-256 checksum
How to use checksums
e7945a384a81f609592a79ace352fe8e7753929b4ae2de773217671acb6eda3c
BLAKE2b-256 checksum
How to use checksums
a278ac3897196b639261c2a55f08a1f7d2afdcb3978a1220e1613eee0aa81d17
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.2 CPython/3.12.10 Linux/6.8.0-1021-azure

Release history Release notifications | RSS feed

This release

0.6.7 This release

2 release files

0.6.6

2 release files

0.6.5

2 release files

0.6.4

2 release files

0.6.3

2 release files

0.6.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page