icecube.common_variables.hit_multiplicity.segments module

The segments Python module of the hit multiplicity sub project of the CommonVariables project contains all available icetray traysegments for calculating and booking hit multiplicity values.

icecube.common_variables.hit_multiplicity.segments.I3HitMultiplicityCalculatorSegment(tray, name, BookIt=False, **i3module_kwargs)

This tray segment adds the icecube.common_variables.I3HitMultiplicityCalculator icetray module to the tray. The traysegment takes the same arguments as the icetray module does, plus the following additional keyword arguments:

Parameters:

BookIt (bool) –

The switch if this traysegment should also generate and return the tableio converter keys for the calculated hit multiplicity values.

The name of the output tableio table for the calculated multiplicity values will be the same as the name of the frame object holding the hit multiplicity values.

Default value is False.

Return None:

If the “BookIt” keyword argument has been set to False.

Return list:

The list of tableio converter keys to book the hit multiplicity values, if the “BookIt” keyword argument has been set to True.

icecube.common_variables.hit_multiplicity.segments.I3HitMultiplicityValuesBookerSegment(tray, name, OutputI3HitMultiplicityValuesName)

This traysegment generates and returns tableio converter keys to book the hit multiplicity calculation results from the frame.

The name of the output tableio table for the calculated multiplicity values will be the same as the name of the frame object holding the hit multiplicity values, e.g. the name specified through the OutputI3HitMultiplicityValuesName parameter.

Parameters:

OutputI3HitMultiplicityValuesName (str) – The name of the icecube.common_variables.hit_multiplicity.I3HitMultiplicityValues object inside the frame.

Return list:

The list of tableio converter keys.