Skip to main content

Batch analyze DICOM-RT Plan files to calculate Complexity Scores

Project description

DVHA logo

build Documentation Status PyPI PyPI lgtm lgtm code quality Codecov Lines of code Repo Size Code style: black

Batch analyze DICOM-RT Plan files to calculate complexity scores

DVH Analytics (DVHA) is a software application for building a local database of radiation oncology treatment planning data. It imports data from DICOM-RT files (i.e., plan, dose, and structure), creates a SQL database, provides customizable plots, and provides tools for generating linear, multi-variable, and machine learning regressions.

DVHA-MLCA is a stand-alone command-line script to batch analyze DICOM-RT Plans using the MLC Analyzer code from DVHA.

Complexity score based on: Younge KC, Matuszak MM, Moran JM, McShan DL, Fraass BA, Roberts DA. Penalization of aperture complexity in inversely planned volumetric modulated arc therapy. Med Phys. 2012;39(11):7160–70.

Installation

To install via pip:

$ pip install dvha-mlca

If you’ve installed via pip or setup.py, launch from your terminal with:

$ mlca <init-scanning-directory>

If you’ve cloned the project, but did not run the setup.py installer, launch DVHA-MLCA with:

$ python mlca/main.py <init-scanning-directory>

Command line usage

usage: mlca [-h] [-of OUTPUT_FILE] [-xw COMPLEXITY_WEIGHT_X]
            [-yw COMPLEXITY_WEIGHT_Y] [-xs MAX_FIELD_SIZE_X]
            [-ys MAX_FIELD_SIZE_Y] [-ver] [-v] [-n PROCESSES]
            [init_dir]

Command line DVHA MLC Analyzer

positional arguments:
  init_dir              Directory containing DICOM-RT Plan files

optional arguments:
  -h, --help            show this help message and exit
  -of OUTPUT_FILE, --output-file OUTPUT_FILE
                        Output will be saved as
                        dvha_mlca_<version>_results_<time-stamp>.csv by
                        default.
  -xw COMPLEXITY_WEIGHT_X, --x-weight COMPLEXITY_WEIGHT_X
                        Complexity coefficient for x-dimension: default = 1.0
  -yw COMPLEXITY_WEIGHT_Y, --y-weight COMPLEXITY_WEIGHT_Y
                        Complexity coefficient for y-dimension: default = 1.0
  -xs MAX_FIELD_SIZE_X, --x-max-field-size MAX_FIELD_SIZE_X
                        Maximum field size in the x-dimension: default = 400.0
                        (mm)
  -ys MAX_FIELD_SIZE_Y, --y-max-field-size MAX_FIELD_SIZE_Y
                        Maximum field size in the y-dimension: default = 400.0
                        (mm)
  -ver, --version       Print the DVHA-MLCA version
  -v, --verbose         Print final results and plan summaries as they are
                        analyzed
  -n PROCESSES, --processes PROCESSES
                        Enable multiprocessing, set number of parallel
                        processes

For example:

$ mlca "C:\PatientDicom" -n 8
Directory: C:\PatientDicom
Begin file tree scan ...
File tree scan complete
Searching for DICOM-RT Plan files ...
     100%|██████████████████████████████| 9087/9087 [00:59<00:00, 153.52it/s]
1650 DICOM-RT Plan file(s) found
Analyzing 1650 file(s) ...
      10%|███                           | 169/1650 [02:02<13:35,  1.82it/s]

Dependencies

Support

If you like DVHA-MLCA and would like to support our mission, all we ask is that you cite us if we helped your publication, or help the DVHA community by submitting bugs, issues, feature requests, or solutions on the issues page.

Cite

DOI: https://doi.org/10.1002/acm2.12401 Cutright D, Gopalakrishnan M, Roy A, Panchal A, and Mittal BB. “DVH Analytics: A DVH database for clinicians and researchers.” Journal of Applied Clinical Medical Physics 19.5 (2018): 413-427.

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

dvha-mlca-0.2.3.post1.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

dvha_mlca-0.2.3.post1-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file dvha-mlca-0.2.3.post1.tar.gz.

File metadata

  • Download URL: dvha-mlca-0.2.3.post1.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.8

File hashes

Hashes for dvha-mlca-0.2.3.post1.tar.gz
Algorithm Hash digest
SHA256 e95685e26ed35c99b068ff818603f7c810b9dc24ecd55bae9334148ef23764ad
MD5 a1df69c047a0226995ad4c69fa09ac99
BLAKE2b-256 7ce92dbcbb0f4817a72bb746de72a45d61b8dca82618590bdae97381060bcdab

See more details on using hashes here.

File details

Details for the file dvha_mlca-0.2.3.post1-py3-none-any.whl.

File metadata

  • Download URL: dvha_mlca-0.2.3.post1-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.8

File hashes

Hashes for dvha_mlca-0.2.3.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 55d626be39f4a898f8402f98f8fdc0d7af8bbdb23733617f3da3eff275e90d61
MD5 65f6e6294a8c86afee6475243ef946b8
BLAKE2b-256 5ce78e87459445e2b66c9ef2227b94ec8f436b7a0d379234b57af57ea9fe7761

See more details on using hashes here.

Supported by

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