reboost.spms package

Submodules

reboost.spms.pe module

reboost.spms.pe.detected_photoelectrons(num_scint_ph, particle, time, xloc, yloc, zloc, optmap, material, spm_detector_uid, map_scaling=1)

Derive the number of detected photoelectrons (p.e.) from scintillator hits using an optical map.

Parameters:

  • num_scint_ph (Array) – array of emitted scintillation photons, as generated by emitted_scintillation_photons().

  • particle (Array) – array of particle PDG IDs of scintillation events.

  • time (Array) – array of timestamps of scintillation events.

  • xloc (Array) – array of x coordinate position of scintillation events.

  • yloc (Array) – array of y coordinate position of scintillation events.

  • zloc (Array) – array of z coordinate position of scintillation events.

  • optmap (OptmapForConvolve) – the optical map loaded via py:func:load_optmap.

  • material (str) – scintillating material name.

  • spm_detector_uid (int) – SiPM detector uid as used in the optical map.

  • map_scaling (float) – scale the detection probability in the map for this detector by this factor.

Return type:

VectorOfVectors

reboost.spms.pe.emitted_scintillation_photons(edep, particle, material)

Derive the number of emitted scintillation photons from scintillator hits.

Parameters:

  • edep (Array) – array of deposited energy in scintillation events.

  • particle (Array) – array of particle PDG IDs of scintillation events.

  • material (str) – scintillating material name.

Return type:

VectorOfVectors

reboost.spms.pe.load_optmap(map_file, spm_det_uid)

Load an optical map file for later use with detected_photoelectrons().

Parameters:

  • map_file (str)

  • spm_det_uid (int)

Return type:

OptmapForConvolve

reboost.spms.pe.load_optmap_all(map_file)

Load an optical map file for later use with detected_photoelectrons().

Parameters:

map_file (str)

Return type:

OptmapForConvolve