icecube.clsim.traysegments.I3CLSimMakeHitsFromPhotons module

icecube.clsim.traysegments.I3CLSimMakeHitsFromPhotons.I3CLSimMakeHitsFromPhotons(tray, name, PhotonSeriesName='PhotonSeriesMap', MCPESeriesName='MCPESeriesMap', RandomService=None, DOMOversizeFactor=5.0, UnshadowedFraction=0.94, DOMEfficiency=1, IceModelLocation=None, HoleIceParameterization='/Users/buildbot/actions-runner/_work/icetray/build/ice-models/resources/models/ANGSENS/angsens/as.h2-50cm', CableOrientation=None, MergeHits=False, GCDFile=None, If=<function <lambda>>)

Convert I3Photons into I3MCPEs. This applies the DOM angular acceptance (and wavenelgth acceptance in case you are using the unbiased photon propagation mode.)

Parameters:

  • PhotonSeriesName – Name of the input I3PhotonSeriesMap to be converted.

  • MCPESeriesName – Name of the output I3MCPESeriesMap written by the module. Set this to None to prevent generating MCPEs from Photons.

  • RandomService – Set this to an instance of a I3RandomService. Alternatively, you can specify the name of a configured I3RandomServiceFactory added to I3Tray using tray.AddService(). If you don’t configure this, the default I3RandomServiceFactory will be used.

  • DOMOversizeFactor – Set the DOM oversize factor. To disable oversizing, set this to 1.

  • UnshadowedFraction – Fraction of photocathode available to receive light (e.g. unshadowed by the cable)

  • DOMEfficiency – Sets the global energy scale relative to the unshadowed detector, independent of ice.

  • HoleIceParameterization – Set this to a hole ice parameterization file. The default file contains the coefficients for nominal angular acceptance correction due to hole ice (ice-models project is required). Use file $I3_BUILD/ice-models/resources/models/ANGSENS/angsens/as.nominal for no hole ice parameterization.

  • CableOrientation – Path to cable orientation file, e.g. $I3_BUILD/ice-models/resources/models/PPCTABLES/cable_position/orientation.led7.txt. If set, blocks photons that would have to pass through the best-fit position of the cable to reach a DOM. This reduces the isotropic efficiency by ~10%. Set to None to disable simulation of the cable shadow.

  • MergeHits – Set to true to perform time merging on the MCPE as they are produced. This is useful for reducing the memory and disk space used by high energy (bright) events, and can allow detector simulation to run much more quickly. This causes parent particle information to be stored in an additional frame object.

  • If – Python function to use as conditional execution test for segment modules.

icecube.clsim.traysegments.I3CLSimMakeHitsFromPhotons.unchanged(func)