3.10.1.2.1.7. opengate.actors.digitizers

3.10.1.2.1.7.1. Classes

Digitizer	Simple helper class to reduce the code size when creating a digitizer.
DigitizerBase
DigitizerAdderActor	Equivalent to Gate "adder": gather all hits of an event in the same volume.
DigitizerBlurringActor	Digitizer module for blurring an attribute (single value only, not a vector).
DigitizerSpatialBlurringActor	Digitizer module for blurring a (global) spatial position.
DigitizerEfficiencyActor	Digitizer module for simulating efficiency.
DigitizerEnergyWindowsActor	Consider a list of hits and arrange them according to energy intervals.
DigitizerHitsCollectionActor	Build a list of hits in a given volume.
DigitizerProjectionActor	This actor takes as input HitsCollections and performed binning in 2D images.
DigitizerReadoutActor	This actor is a DigitizerAdderActor + a discretization step:
PhaseSpaceActor	Similar to HitsCollectionActor : store a list of hits.

3.10.1.2.1.7.2. Functions

ene_win_peak(name, energy, energy_width_percent)
ene_win_down_scatter(name, peak_min_value, ...)
ene_win_up_scatter(name, peak_max_value, ...)
energy_windows_peak_scatter(peak_name, ...[, ...])
get_simplified_digitizer_channels_Tc99m(spect_name, ...)
get_simplified_digitizer_channels_Lu177(spect_name, ...)
get_simplified_digitizer_channels_In111(spect_name, ...)
get_simplified_digitizer_channels_I131(spect_name, ...)
get_simplified_digitizer_channels_rad(spect_name, rad, ...)

3.10.1.2.1.7.3. Module Contents

opengate.actors.digitizers.ene_win_peak(name, energy, energy_width_percent)

opengate.actors.digitizers.ene_win_down_scatter(name, peak_min_value, energy_width_percent)

opengate.actors.digitizers.ene_win_up_scatter(name, peak_max_value, energy_width_percent)

opengate.actors.digitizers.energy_windows_peak_scatter(peak_name, down_scatter_name, up_scatter_name, peak, peak_width, down_scatter_width, up_scatter_width=None)

opengate.actors.digitizers.get_simplified_digitizer_channels_Tc99m(spect_name, scatter_flag)

opengate.actors.digitizers.get_simplified_digitizer_channels_Lu177(spect_name, scatter_flag)

opengate.actors.digitizers.get_simplified_digitizer_channels_In111(spect_name, scatter_flag)

opengate.actors.digitizers.get_simplified_digitizer_channels_I131(spect_name, scatter_flag)

opengate.actors.digitizers.get_simplified_digitizer_channels_rad(spect_name, rad, scatter_flag)

class opengate.actors.digitizers.Digitizer(sim, volume_name, digit_name)

Simple helper class to reduce the code size when creating a digitizer. It only avoids repeating attached_to, output and input_digi_collection parameters.

simulation

volume_name

name

actors = []

hc

set_hit_collection()

add_module(module_type, module_name=None)

get_last_module()

find_first_module(s)

Find the first module that contains the s string

class opengate.actors.digitizers.DigitizerBase(*args, **kwargs)

Bases: opengate.actors.base.ActorBase

_output_name_root = 'root_output'

authorize_repeated_volumes: bool

user_info_defaults

_add_user_output_root(**kwargs)

Specialized method to add a root user output in digitizers. The output name is hard-coded at the class-level and the same for all digitizers, i.e. in all digitizers, the user can do: digitizer.user_output.root_output Additionally, the C++ classes expect an output with this name.

initialize()

class opengate.actors.digitizers.DigitizerAdderActor(*args, **kwargs)

Bases: DigitizerBase, opengate_core.GateDigitizerAdderActor

Equivalent to Gate “adder”: gather all hits of an event in the same volume. Input: a HitsCollection, need aat least TotalEnergyDeposit and PostPosition attributes Output: a Single collections

Policies: - EnergyWinnerPosition: consider position and energy of the hit with the max energy

for all other attributes (Time, etc.): the value of the winner is used.

• EnergyWeightedCentroidPosition: computed the energy-weighted centroid position

  for all other attributes (Time, etc.): the value the last seen hit is used.

user_info_defaults

__initcpp__()

initialize()

set_group_by_depth()

StartSimulationAction()

EndSimulationAction()

class opengate.actors.digitizers.DigitizerBlurringActor(*args, **kwargs)

Bases: DigitizerBase, opengate_core.GateDigitizerBlurringActor

Digitizer module for blurring an attribute (single value only, not a vector). Usually for energy or time.

user_info_defaults

type_name = 'DigitizerBlurringActor'

__initcpp__()

initialize()

initialize_blurring_parameters()

set_param_gauss()

set_param_inverse_square()

set_param_linear()

StartSimulationAction()

EndSimulationAction()

class opengate.actors.digitizers.DigitizerSpatialBlurringActor(*args, **kwargs)

Bases: DigitizerBase, opengate_core.GateDigitizerSpatialBlurringActor

Digitizer module for blurring a (global) spatial position.

user_info_defaults

__initcpp__()

initialize_blurring_parameters()

initialize()

StartSimulationAction()

EndSimulationAction()

class opengate.actors.digitizers.DigitizerEfficiencyActor(*args, **kwargs)

Bases: DigitizerBase, opengate_core.GateDigitizerEfficiencyActor

Digitizer module for simulating efficiency.

user_info_defaults

__initcpp__()

initialize_blurring_parameters()

initialize()

StartSimulationAction()

EndSimulationAction()

class opengate.actors.digitizers.DigitizerEnergyWindowsActor(*args, **kwargs)

Bases: DigitizerBase, opengate_core.GateDigitizerEnergyWindowsActor

Consider a list of hits and arrange them according to energy intervals. Input: one DigiCollection Output: as many DigiCollections as the number of energy windows

user_info_defaults

__initcpp__()

initialize()

StartSimulationAction()

EndSimulationAction()

class opengate.actors.digitizers.DigitizerHitsCollectionActor(*args, **kwargs)

Bases: DigitizerBase, opengate_core.GateDigitizerHitsCollectionActor

Build a list of hits in a given volume. - the list of attributes to be stored is given in the ‘attributes’ options - output as root

user_info_defaults

__initcpp__()

initialize()

StartSimulationAction()

EndSimulationAction()

class opengate.actors.digitizers.DigitizerProjectionActor(*args, **kwargs)

Bases: DigitizerBase, opengate_core.GateDigitizerProjectionActor

This actor takes as input HitsCollections and performed binning in 2D images. If there are several HitsCollection as input, the slices will correspond to each HC. If there are several runs, images will also be slice-stacked.

input_digi_collections: List[str]

spacing: List[float]

size: List[int]

physical_volume_index: int

origin_as_image_center: bool

detector_orientation_matrix: numpy.ndarray

user_info_defaults

start_output_origin = None

__initcpp__()

initialize()

property output_size

property output_spacing

compute_thickness(volume, channels)

Get the thickness of the detector volume, in the correct direction. By default, it is Z. We use the ‘projection_orientation’ to get the correct one.

StartSimulationAction()

EndSimulationAction()

class opengate.actors.digitizers.DigitizerReadoutActor(*args, **kwargs)

Bases: DigitizerAdderActor, opengate_core.GateDigitizerReadoutActor

This actor is a DigitizerAdderActor + a discretization step: the final position is the center of the volume

user_info_defaults

__initcpp__()

StartSimulationAction()

EndSimulationAction()

class opengate.actors.digitizers.PhaseSpaceActor(*args, **kwargs)

Bases: DigitizerBase, opengate_core.GatePhaseSpaceActor

Similar to HitsCollectionActor : store a list of hits. However only the first hit of given event is stored here.

user_info_defaults

total_number_of_entries = 0

number_of_absorbed_events = 0

__initcpp__()

initialize()

StartSimulationAction()

EndSimulationAction()