SpreadOutBraggPeakAnalysis#

class georges.ptw.SpreadOutBraggPeakAnalysis(dose_data: ~pandas.core.frame.DataFrame | None = None, method: str = <module 'scipy.optimize' from '/home/runner/work/georges/georges/.venv/lib/python3.10/site-packages/scipy/optimize/__init__.py'>, z_axis: ~numpy.array | None = None, color: str = 'blue', str_on_legend: str = '', adjust_last_peak: float = 1.0)[source]#

Bases: object

This class takes a set of Bragg peaks, or a Bragg peak library, as input and computes the relative weights required to obtain a uniform depth dose profile, known as the SOBP. Additionally, this class processes the resulting SOBP and provides the flatness, DFO, and distal range at a given percentage of the maximum to the user.

Methods Summary

`compute_ranges`()
`compute_sobp_profile`()
`compute_weights`()
`get_final_weights`()
`get_library_max_ranges`()
`get_sobp_flatness`()
`get_sobp_r10`()
`get_sobp_r20`()
`get_sobp_r80`()
`get_sobp_r90`()
`get_ur_max_dose`()
`get_ur_min_dose`()
`recompute_sobp_for_another_range`(bp_to_leave)
`recompute_sobp_for_another_width`(bp_to_leave)
`sobp_data`()
`view_sobp`([with_pristine_peaks])

Methods Documentation

compute_ranges()[source]#

compute_sobp_profile() → array[source]#

compute_weights() → array[source]#

get_final_weights()[source]#

get_library_max_ranges()[source]#

get_sobp_flatness()[source]#

get_sobp_r10()[source]#

get_sobp_r20()[source]#

get_sobp_r80()[source]#

get_sobp_r90()[source]#

get_ur_max_dose()[source]#

get_ur_min_dose()[source]#

recompute_sobp_for_another_range(bp_to_leave)[source]#

recompute_sobp_for_another_width(bp_to_leave)[source]#

sobp_data() → array[source]#

view_sobp(with_pristine_peaks=False)[source]#