hexsample.mc — Monte Carlo facilities

Module documentation

Monte Carlo facilities.

class hexsample.mc.MonteCarloEvent(timestamp: float, energy: float, absx: float, absy: float, absz: float, num_pairs: int)

Descriptor for the ground truth of a simulated event.

Parameters:

• timestamp (float) – The timestamp for the event in s.

• energy (float) – The energy of the event in eV.

• x (float) – The x coordinate of the photon absorption point in cm.

• y (float) – The y coordinate of the photon absorption point in cm.

• z (float) – The z coordinate of the photon absorption point in cm.

• num_pairs (int) – The number of electron-hole pairs created in the detector active volume.

timestamp: float

energy: float

absx: float

absy: float

absz: float

num_pairs: int

propagate(diffusion_sigma: float)

Propagate the primary ionization down to the readout plane.

class hexsample.mc.PhotonList(source: Source, sensor: Sensor, num_photons: int)

Small convenience class representing a simulated photon list.

Parameters:

• source (Source) – The X-ray source.

• sensor (Sensor) – The X-ray sensor.

• num_photons (int) – The number of photons to be simulated.