3.10.1.2.1.7. opengate.actors.doseactors

3.10.1.2.1.7.1. Classes

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.7.2. Module Contents

class opengate.actors.doseactors.DoseActor(user_info)

Bases: opengate_core.GateDoseActor, opengate.actors.base.ActorBase

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

type_name = 'DoseActor'

set_default_user_info()

g4_phys_vol = None

py_edep_image = None

py_temp_image = None

py_square_image = None

py_last_id_image = None

uncertainty_image = None

img_origin_during_run = None

first_run = None

output_origin = None

__str__()

__getstate__()

This is important : to get actor’s outputs from a simulation run in a separate process, the class must be serializable (pickle). The engines (volume, actor, etc.) and G4 objects are also removed if exists.

initialize(volume_engine=None)

At the start of the run, the image is centered according to the coordinate system of the mother 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.

StartSimulationAction()

EndSimulationAction()

compute_dose_from_edep_img()

• 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

fetch_square_image_from_cpp()

compute_std_from_sample(N, val, val_squared, correct_bias=False)

create_uncertainty_img()

class opengate.actors.doseactors.LETActor(user_info)

Bases: opengate_core.GateLETActor, opengate.actors.base.ActorBase

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 …

type_name = 'LETActor'

set_default_user_info()

g4_phys_vol = None

py_numerator_image = None

py_denominator_image = None

py_output_image = None

img_origin_during_run = None

first_run = None

output_origin = None

__str__()

__getstate__()

This is important : to get actor’s outputs from a simulation run in a separate process, the class must be serializable (pickle). The engines (volume, actor, etc.) and G4 objects are also removed if exists.

initialize(volume_engine=None)

At the start of the run, the image is centered according to the coordinate system of the mother 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.

StartSimulationAction()

EndSimulationAction()

class opengate.actors.doseactors.FluenceActor(user_info)

Bases: opengate_core.GateFluenceActor, opengate.actors.base.ActorBase

FluenceActor: compute a 3D map of fluence

FIXME: add scatter order and uncertainty

type_name = 'FluenceActor'

set_default_user_info()

g4_phys_vol = None

py_fluence_image = None

__str__()

__getstate__()

This is important : to get actor’s outputs from a simulation run in a separate process, the class must be serializable (pickle). The engines (volume, actor, etc.) and G4 objects are also removed if exists.

initialize(volume_engine=None)

StartSimulationAction()

EndSimulationAction()