Skip to content

ATKoala/automated-plan-checking

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

automated-plan-checking

Extract and evaluate data from DICOM RT-PLAN files.

README best viewed on the github page

Table of contents

Project background

System Setup

Installation and Usage

Documentation List

Project background

This project is with the Australian Radiation Protection and Nuclear Safety Agency.

The aim is to create a program that can perform an automated check of data and parameters with a Pass/Fail result.

Currently, the process to verify planning parameters is to manually check pdf print outs. The information required is contained in the DICOM RT-PLAN files created for each treatment plan. The goal is a program that can directly extract the information from the DICOM file and then compare this data to a standard data set to produce a pass/fail evaluation.

System Setup

Before you run the program, you will need to make sure your computer has the required software and libraries installed. The following sections will guide you through this process.

Anaconda Setup

If you have Anaconda or are willing to install Anaconda, the setup can be done with the following steps. Update Anaconda before doing any of these steps.

  1. Open Spyder (from Anaconda Navigator in the image, but not required to open from Navigator) Spyder in Anaconda Navigator

  2. Check the Python version. If it's lower than 3.6, run conda update python in the Spyder console. Checking Python version in Spyder

  3. Anaconda comes with the pandas package preinstalled, but check it with conda list pandas in the console. Check for pandas

    • If it's missing, try running conda install pandas in the console.
  4. Install the pydicom package with conda install -c conda-forge pydicom Running conda install pydicom

Pip Setup

Without Anaconda, it's also possible to set up directly through the command line/shell, with "pip", the python package manager.

  1. Ensure Python version 3.6 or higher by running python --version in the command line
  2. Check that you can use pip, with pip --version.
    • If it returns "pip is not recognized ...", try using python -m pip --version instead.
  3. Install pandas (Check if already installed with pip show pandas. Install with pip install pandas)
  4. Install pydicom (Check with pip show pydicom. Install with pip install pydicom)

Installation and Usage

Installation

  1. From the github page, click the green Code button and select the 'Download ZIP' option.
  2. Unzip the folder and move it to wherever you want.

Usage

  1. In Spyder, navigate to the directory in which the program is saved and open app.py.
  2. Click Run. On a fresh install from github, it will run the program on sample dicoms in the 'data' folder. Running in spyder
  3. It may be desirable to use the settings file and specify different input locations depending on where your dicoms are, each time you run the program.

More options for usage can be found in the User guide.

Documentation List

For Users

For Developers