Skip to content

Latest commit

 

History

History
137 lines (93 loc) · 3.35 KB

quart.rst

File metadata and controls

137 lines (93 loc) · 3.35 KB
Raw

Quart

3.2

Overview

The Quart module provides routines for automatically analyzing DICOM images of the Quart DVT phantom typically used with the Halcyon linac system. It can load a folder or zip file of images, correcting for translational and rotational offsets.

3.2

Warning

These algorithms have only a limited amount of testing data and results should be scrutinized. Further, the algorithm is more likely to change in the future when a more robust test suite is built up. If you'd like to submit data, enter it here.

Typical Use

The Quart phantom analysis follows a similar pattern of load/analyze/output as the rest of the library. Unlike the CatPhan analysis, customization is not a goal, as the phantoms and analyses are much more well-defined. I.e. there's less of a use case for custom phantoms in this scenario.

To use the Quart analysis, import the class:

from pylinac import QuartDVT
from pylinac.quart import QuartDVT  # equivalent import

And then load, analyze, and view the results:

  • Load images -- Loading can be done with a directory or zip file:

    quart_folder = r"C:/CT/Quart/Sept 2021"
quart = QuartDVT(quart_folder)

    or load from zip:

    quart_folder = r"C:/CT/Quart/Sept 2021.zip"  # this contains all the DICOM files of the scan
quart = QuartDVT.from_zip(quart_folder)

  • Analyze -- Analyze the dataset:

    quart.analyze()

  • View the results -- Reviewing the results can be done in text or dict format as well as images:

    # print text to the console
print(quart.results())
# view analyzed image summary
quart.plot_analyzed_image()
# view images independently
quart.plot_images()
# save the images
quart.save_images()
# finally, save a PDF
quart.publish_pdf('myquart.pdf')

Advanced Use

Using results_data

Using the Quart module in your own scripts? While the analysis results can be printed out, if you intend on using them elsewhere (e.g. in an API), they can be accessed the easiest by using the ~pylinac.quart.QuartDVT.results_data method which returns a ~pylinac.acr.QuartDVTResult instance.

Continuing from above:

data = quart.results_data()
data.hu_module.roi_radius_mm
# and more

# return as a dict
data_dict = quart.results_data(as_dict=True)
data_dict['hu_module']['roi_radius_mm']
...

API Documentation

pylinac.quart.QuartDVT

pylinac.quart.QuartHUModule

pylinac.quart.QuartUniformityModule

pylinac.quart.QuartGeometryModule

pylinac.quart.QuartDVTResult

pylinac.quart.QuartHUModuleOutput

pylinac.quart.QuartUniformityModuleOutput

pylinac.quart.QuartGeometryModuleOutput