pyanno4rt.evaluation

Treatment plan evaluation module.

This module aims to provide methods and classes to evaluate the generated treatment plans.

Overview

Classes
`DosimetricsEvaluator`	Dosimetrics evaluation class.
`DVHEvaluator`	DVH evaluation class.

Classes

class pyanno4rt.evaluation.DosimetricsEvaluator(reference_volume, reference_dose, display_segments, display_metrics)[source]

Dosimetrics evaluation class.

This class provides methods to evaluate dosimetrics as a means to quantify dose distributions from a treatment plan across the segments. Dosimetrics include statistical location and dispersion measures, DVH indicators as well as conformity (CI) and homogeneity index (HI).

Parameters:

reference_volume (list) – Reference volumes for which to evaluate the inverse DVH indicators.
reference_dose (list) – Reference dose values for which to evaluate the DVH indicators.
display_segments (list) – Names of the segmented structures to be displayed.
display_metrics (list) – Names of the metrics to be displayed.

reference_volume

See ‘Parameters’.

Type:: tuple

reference_dose

See ‘Parameters’.

Type:: tuple

display_segments

See ‘Parameters’.

Type:: tuple

display_metrics

See ‘Parameters’.

Type:: tuple

Overview

Methods
`evaluate`(dose_cube)	Evaluate the dosimetrics for all segments.

Members

evaluate(dose_cube)[source]

Evaluate the dosimetrics for all segments.

Parameters:: dose_cube (ndarray) – Three-dimensional array with the dose values (CT resolution).

class pyanno4rt.evaluation.DVHEvaluator(dvh_type, number_of_points, display_segments)[source]

DVH evaluation class.

This class provides methods to evaluate dose-volume histograms (DVH) as a means to quantify dose distributions from a treatment plan across the segments. Both cumulative and differential DVH can be evaluated.

Parameters:

dvh_type ({'cumulative', 'differential'}) – Type of DVH to be evaluated.
number_of_points (int) – Number of (evenly-spaced) points for which to evaluate the DVH.
display_segments (list) – Names of the segmented structures to be displayed.

dvh_type

See ‘Parameters’.

Type:: {‘cumulative’, ‘differential’}

number_of_points

See ‘Parameters’.

Type:: int

display_segments

See ‘Parameters’.

Type:: tuple

Overview

Methods
`evaluate`(dose_cube)	Evaluate the DVH for all segments.

Members

evaluate(dose_cube)[source]

Evaluate the DVH for all segments.

Parameters:: dose_cube (ndarray) – Three-dimensional array with the dose values (CT resolution).