Skip to main content

Optimized Multichannel Gafchromic Dosimetry (OMG Dosimetry)

Project description

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

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

omg_dosimetry-1.8.1.tar.gz (89.3 kB view details)

Uploaded Source

Built Distribution

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

omg_dosimetry-1.8.1-py3-none-any.whl (81.9 kB view details)

Uploaded Python 3

File details

Details for the file omg_dosimetry-1.8.1.tar.gz.

File metadata

  • Download URL: omg_dosimetry-1.8.1.tar.gz
  • Upload date:
  • Size: 89.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for omg_dosimetry-1.8.1.tar.gz
Algorithm Hash digest
SHA256 c7a70ba16becd10548830780263ca1db85d6530993c6ebd480aaf8b0d8ea002d
MD5 afa123f9ef7994a5e00a48d9ca942a2d
BLAKE2b-256 c676a404d888af04c25df68156146e7233d3e288df125588d9407b01cd11699b

See more details on using hashes here.

Provenance

The following attestation bundles were made for omg_dosimetry-1.8.1.tar.gz:

Publisher: publish-to-test-pypi.yml on jfcabana/omg_dosimetry

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

File details

Details for the file omg_dosimetry-1.8.1-py3-none-any.whl.

File metadata

  • Download URL: omg_dosimetry-1.8.1-py3-none-any.whl
  • Upload date:
  • Size: 81.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for omg_dosimetry-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cfc5de33af693112cef08236f66a17650a547ee251f5b05ad4d4a2f92be9cf65
MD5 0e79470d37dd5ca4e9727db0f113d642
BLAKE2b-256 c51d8700ae2c6d59e383f67d9373fc76c5b484d681802a9019dfcfcd3408f168

See more details on using hashes here.

Provenance

The following attestation bundles were made for omg_dosimetry-1.8.1-py3-none-any.whl:

Publisher: publish-to-test-pypi.yml on jfcabana/omg_dosimetry

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