Skip to main content

OMG Dosimetry

https://github.com/jfcabana/omg_dosimetry/blob/OMG_master/src/omg_dosimetry/OMG_Logo.png?raw=true

With OMG Dosimetry, you can easily perform film calibration, film-to-dose conversion, and dose analysis.

Demonstration files are provided for each module to get you started quickly. Code is heavily commented so you can follow along and adapt it for your personal usage.

Documentation

To get started, install the package, view the API docs, visit the Full Documentation on Read The Docs.

Gafchromic Calibration Module

The calibration module computes multichannel calibration curves from scanned films.

Scanned films are automatically detected and selected, or ROIs can be drawn manually.

The lateral scanner response effect (inhomogeneous response of the scanner along the detector array) can be accounted for by creating separate calibration curves for each pixel along the array. This requires exposing long film strips and scanning them perpendicular to the scan direction (see demonstration files). To account for non-flat beam profiles, a text file containing the relative beam profile shape along the film strips can be given as input to correct for non-uniform dose on the film. Alternatively, the lateral scanner response correction can be turned off in which a single calibration curve is computed for all pixels. This simpler calibration is adequate if scanning only small films at a reproducible location on the scanner.

Features

  • Automatically loads multiple images in a folder, averages multiple copies of the same image and stacks different scans together.

  • Automatically detects film position and size, and defines ROIs inside these films.

  • Daily output correction

  • Beam profile correction

  • Lateral scanner response correction

  • Save/Load LUT files

  • Publish PDF report

Film-to-Dose Module

The film-to-dose module performs optimized multichannel conversion from scanned gafchromic films to absolute dose. It uses the optimized multichannel method from Mayer et al (https://doi.org/10.1118/1.3694100) and calibration curves obtained with the calibration module.

Features

  • Multiple scans of same film are loaded and averaged automatically

  • Automatic film detection and crop

  • Multichannel optimized conversion to absolute dose (reduced film inhomogeneities/artefacts)

  • Lateral scanner response is accounted for if this feature was turned on during calibration

  • Calibration curve interpolation performed by fitting either a rational function or spline curve

  • Output individual channels dose (R/G/B), as well as optimized dose, mean channel dose and average dose

  • Output metrics for evaluation of dose conversion quality: disturbance map, residual error, consistency map

  • Publish PDF report

Dose Analysis Module

The dose analysis module performs in-depth comparison from film dose to reference dose image from treatment planning system.

Features

  • Perform registration by identifying fiducial markers to set isocenter

  • Interactive display of analysis results (gamma map, relative error, dose profiles)

  • Gamma analysis: display gamma map, pass rate, histogram, pass rate vs dose bar graph, pass rate vs distance to agreement (fixed dose to agreement), pass rate vs dose to agreement (fixed distance to agreement)

  • Publish PDF report

Metadata

Release files for omg-dosimetry 1.8.1

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

Source distribution (sdist)

Source distribution for omg-dosimetry 1.8.1
File Size Uploaded
omg_dosimetry-1.8.1.tar.gz 89.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for omg-dosimetry 1.8.1
File Interpreter ABI Platform
omg_dosimetry-1.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 171.2 kB

Release files / omg_dosimetry-1.8.1.tar.gz

Download URL omg_dosimetry-1.8.1.tar.gz
Size 89.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c7a70ba16becd10548830780263ca1db85d6530993c6ebd480aaf8b0d8ea002d
BLAKE2b-256 checksum
How to use checksums
c676a404d888af04c25df68156146e7233d3e288df125588d9407b01cd11699b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 29, 2025.

Transparency log

Release files / omg_dosimetry-1.8.1-py3-none-any.whl

Download URL omg_dosimetry-1.8.1-py3-none-any.whl
Size 81.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cfc5de33af693112cef08236f66a17650a547ee251f5b05ad4d4a2f92be9cf65
BLAKE2b-256 checksum
How to use checksums
c51d8700ae2c6d59e383f67d9373fc76c5b484d681802a9019dfcfcd3408f168
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 29, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

1.8.1 This release

2 release files

1.8.0

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.3

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.5

2 release files

1.5.1

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

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