Skip to main content

Python tool for image dewarping and flame front tracking in experimental fire research.

Project description

FlameTrack

Release Quality Documentation
PyPI Latest Release CI Status Documentation Status
PyPI - Python Version codecov DOI
License linting: ruff

FlameTrack is a desktop application for analysing fire spread from infrared and visible-light recordings. It corrects perspective distortion, detects the flame edge frame-by-frame, and stores all results in a documented HDF5 file.

FlameTrack pipeline — calibration and dewarping FlameTrack analysis — flame spread curve


Features

  • Two experiment modes — Room Corner (6-point calibration) and Lateral Flame Spread (4-point calibration)
  • Automatic point sorting — click the corners in any order, FlameTrack arranges them correctly
  • Six edge-detection methods with adjustable thresholds and optional Otsu masking
  • Parallel processing — Room Corner runs both panels simultaneously
  • Reproducible results — every HDF5 output file stores the FlameTrack version and git commit used

Installation

pip install flametrack
flametrack

Requires Python 3.10 – 3.13. Full documentation: flametrack.readthedocs.io


Typical workflow

  1. Click Open Folder and select your experiment directory
  2. Place calibration points on the specimen plate corners
  3. Enter the plate dimensions in millimetres
  4. Click DewarpFind Edge
  5. Open the resulting .h5 file in Python, MATLAB, or any HDF5 viewer

Reading results in Python

import h5py
import numpy as np

with h5py.File("my_experiment_results_RCE.h5", "r") as f:
    edge = f["edge_results"]["data"][:]   # shape: (frames, rows)
    # edge[t, y] = x-position of the flame edge at row y in frame t

Development installation

git clone https://github.com/FireDynamics/FlameTrack.git
cd FlameTrack
pip install -e ".[dev]"
pre-commit install
pytest tests/unit/

Citation

If you use FlameTrack in your work, please cite:

DOI

For the latest release (v1.0.1) the BibTeX entry is:

@software{wurzburger_2026_flametrack,
  author       = {Würzburger, Minh Tam and
                  Fehr, Marc},
  title        = {FlameTrack — Flame Spread Analysis Tool},
  month        = apr,
  year         = 2026,
  publisher    = {Zenodo},
  version      = {v1.0.1},
  doi          = {10.5281/zenodo.19891130},
  url          = {https://doi.org/10.5281/zenodo.19891130},
}

If you used a different version, please use Zenodo to get the correct citation information.


Contributing

Bug reports, feature suggestions, and pull requests are welcome. Please open an issue or see the Contributing Guide.


License

See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flametrack-1.0.2.tar.gz (21.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flametrack-1.0.2-py3-none-any.whl (61.9 kB view details)

Uploaded Python 3

File details

Details for the file flametrack-1.0.2.tar.gz.

File metadata

  • Download URL: flametrack-1.0.2.tar.gz
  • Upload date:
  • Size: 21.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flametrack-1.0.2.tar.gz
Algorithm Hash digest
SHA256 a534f07be20e0659d0a5929a5fc825a23bb1d272588e87f12ed98e4dce3b5379
MD5 803f90bbbb8ed61c68d66bb7310e8e87
BLAKE2b-256 919aa06118aae4f216c46c82f3e70bed55041e7d9902c654149a0110aaf9b8e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for flametrack-1.0.2.tar.gz:

Publisher: release.yml on FireDynamics/FlameTrack

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flametrack-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: flametrack-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 61.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flametrack-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cd0c15d5e1b4736a7fa44b08bc88558b0ab0241e5e7ab45aa0884372476afe7b
MD5 07575dc761d40cdd8638babf5d041485
BLAKE2b-256 1b122269d443e5ce64b16ab127e8b10a0a044ef729d23ac86744498b821ae5a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for flametrack-1.0.2-py3-none-any.whl:

Publisher: release.yml on FireDynamics/FlameTrack

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page