3.10.1.2.1.8. opengate.actors.doseactors

3.10.1.2.1.8.1. Classes

VoxelDepositActor

Base class which holds user input parameters common to all actors

DoseActor

DoseActor: compute a 3D edep/dose map for deposited

LETActor

LETActor: compute a 3D edep/dose map for deposited

FluenceActor

FluenceActor: compute a 3D map of fluence

3.10.1.2.1.8.2. Functions

compute_std_from_sample(number_of_samples, ...[, ...])

_setter_hook_ste_of_mean_unbiased(self, value)

_setter_hook_ste_of_mean(self, value)

_setter_hook_uncertainty(self, value)

_setter_hook_goal_uncertainty(self, value)

_setter_hook_score_in_let_actor(self, value)

3.10.1.2.1.8.3. Module Contents

class opengate.actors.doseactors.VoxelDepositActor(*args, **kwargs)[source]

Bases: opengate.actors.base.ActorBase

Base class which holds user input parameters common to all actors that deposit quantities in a voxel grid, e.g. the DoseActor.

size: list[source]
spacing: list[source]
translation: list[source]
rotation: list[source]
repeated_volume_index: int[source]
hit_type: str[source]
output: str[source]
img_coord_system: str[source]
output_coordinate_system: str[source]
user_info_defaults[source]
check_user_input()[source]
get_physical_volume_name()[source]
_update_output_coordinate_system(which_output, run_index)[source]

Method to be called at the end of a run. Note: The output image is aligned with the volume to which the actor as attached at the beginning of a run. So for the option output_coordinate_system=’global’, nothing has to be done here.

prepare_output_for_run(output_name, run_index, **kwargs)[source]
fetch_from_cpp_image(output_name, run_index, *cpp_image)[source]
push_to_cpp_image(output_name, run_index, *cpp_image, copy_data=True)[source]
EndOfRunActionMasterThread(run_index)[source]
EndSimulationAction()[source]

Default virtual method for inheritance

opengate.actors.doseactors.compute_std_from_sample(number_of_samples, value_array, squared_value_array, correct_bias=False)[source]
opengate.actors.doseactors._setter_hook_ste_of_mean_unbiased(self, value)[source]
opengate.actors.doseactors._setter_hook_ste_of_mean(self, value)[source]
opengate.actors.doseactors._setter_hook_uncertainty(self, value)[source]
opengate.actors.doseactors._setter_hook_goal_uncertainty(self, value)[source]
class opengate.actors.doseactors.DoseActor(*args, **kwargs)[source]

Bases: VoxelDepositActor, opengate_core.GateDoseActor

DoseActor: compute a 3D edep/dose map for deposited energy/absorbed dose in the attached volume

The dose map is parameterized with:

  • size (number of voxels)

  • spacing (voxel size)

  • translation (according to the coordinate system of the “attachedTo” volume)

  • no rotation

Position: - by default: centered according to the “attachedTo” volume center - if the attachedTo volume is an Image AND the option “img_coord_system” is True:

the origin of the attachedTo image is used for the output dose. Hence, the dose can be superimposed with the attachedTo volume

Options

  • edep only for the moment

  • later: add dose, uncertainty, squared etc

use_more_ram: bool[source]
score_in: str[source]
user_info_defaults[source]
__initcpp__()[source]

Nothing to do in the base class.

compute_dose_from_edep_img(input_image, density_image=None)[source]
  • create mass image:

    • from ct HU units, if dose actor attached to ImageVolume.

    • from material density, if standard volume

  • compute dose as edep_image / mass_image

initialize(*args)[source]

At the start of the run, the image is centered according to the coordinate system of the attached volume. This function computes the correct origin = center + translation. Note that there is a half-pixel shift to align according to the center of the pixel, like in ITK.

BeginOfRunActionMasterThread(run_index)[source]
EndOfRunActionMasterThread(run_index)[source]
EndSimulationAction()[source]

Default virtual method for inheritance

opengate.actors.doseactors._setter_hook_score_in_let_actor(self, value)[source]
class opengate.actors.doseactors.LETActor(*args, **kwargs)[source]

Bases: VoxelDepositActor, opengate_core.GateLETActor

LETActor: compute a 3D edep/dose map for deposited energy/absorbed dose in the attached volume

The dose map is parameterized with:

  • size (number of voxels)

  • spacing (voxel size)

  • translation (according to the coordinate system of the “attachedTo” volume)

  • no rotation

Position: - by default: centered according to the “attachedTo” volume center - if the attachedTo volume is an Image AND the option “img_coord_system” is True:

the origin of the attachedTo image is used for the output dose. Hence, the dose can be superimposed with the attachedTo volume

Options

  • LETd only for the moment

  • later: LETt, Q, fluence …

averaging_method: str[source]
score_in: str[source]
user_info_defaults[source]
__initcpp__()[source]

Nothing to do in the base class.

initialize()[source]

At the start of the run, the image is centered according to the coordinate system of the attached volume. This function computes the correct origin = center + translation. Note that there is a half-pixel shift to align according to the center of the pixel, like in ITK.

BeginOfRunActionMasterThread(run_index)[source]
EndOfRunActionMasterThread(run_index)[source]
EndSimulationAction()[source]

Default virtual method for inheritance

class opengate.actors.doseactors.FluenceActor(*args, **kwargs)[source]

Bases: VoxelDepositActor, opengate_core.GateFluenceActor

FluenceActor: compute a 3D map of fluence FIXME: add scatter order and uncertainty

uncertainty: bool[source]
scatter: bool[source]
user_info_defaults[source]
__initcpp__()[source]

Nothing to do in the base class.

initialize()[source]

This base class method initializes common settings and should be called in all inheriting classes.

BeginOfRunActionMasterThread(run_index)[source]
EndOfRunActionMasterThread(run_index)[source]
EndSimulationAction()[source]

Default virtual method for inheritance