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.

Arguments

timestampfloat

The timestamp for the event in s.

energyfloat

The energy of the event in eV.

xfloat

The x coordinate of the photon absorption point in cm.

yfloat

The y coordinate of the photon absorption point in cm.

zfloat

The z coordinate of the photon absorption point in cm.

num_pairsint

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.

Arguments

sourceSource

The X-ray source.

sensorSensor

The X-ray sensor.

num_photonsint

The number of photons to be simulated.