icecube.common_variables.hit_statistics.segments module

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

icecube.common_variables.hit_statistics.segments.I3HitStatisticsCalculatorSegment(tray, name, BookIt=False, COGBookRefFrame=icecube._tableio_dataclasses.BookRefFrame.Car, **i3module_kwargs)

This tray segment adds the icecube.common_variables.I3HitStatisticsCalculator 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 statistics values.

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

    Default value is False.

  • COGBookRefFrame (enum dataclasses.converters.I3PositionConverter.BookRefFrame) –

    The specifier of the reference frame into which the COG position should be booked.

    Default value is dataclasses.converters.I3PositionConverter.BookRefFrame.Car.

Return None:

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

Return list:

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

icecube.common_variables.hit_statistics.segments.I3HitStatisticsValuesBookerSegment(tray, name, OutputI3HitStatisticsValuesName, COGBookRefFrame=icecube._tableio_dataclasses.BookRefFrame.Car)

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

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

Parameters:

  • OutputI3HitStatisticsValuesName (str) – The name of the icecube.common_variables.hit_statistics.I3HitStatisticsValues object inside the frame.

  • COGBookRefFrame (enum dataclasses.converters.I3PositionConverter.BookRefFrame) –

    The specifier of the reference frame in which the COG position values should be booked.

    Default value is dataclasses.converters.I3PositionConverter.BookRefFrame.Car.

Return list:

The list of tableio converter keys.