icecube.common_variables.time_characteristics.segments module

The segments Python module of the track sub project of the CommonVariables project contains all available IceCube tray segments for calculating and booking track cut variables.

icecube.common_variables.time_characteristics.segments.I3TimeCharacteristicsCalculatorSegment(tray, name, BookIt=False, **i3module_kwargs)

This tray segment adds the icecube.common_variables.track_.I3TrackCalculator 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 tray segment should also generate and return the tableio converter keys for the generated icecube.common_variables.track_.I3TrackValues frame object.

The name of the output tableio table for the generated I3TrackValues frame object will be the same as the name of the I3TrackValues frame object holding the track cut variables.

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 I3TrackValues frame object, if the “BookIt” keyword argument has been set to True.

icecube.common_variables.time_characteristics.segments.I3TimeCharacteristicsValuesBookerSegment(tray, name, OutputI3TimeCharacteristicsValuesName)

This traysegment generates and returns tableio converter keys to book the I3TimeCharacteristicsValues frame object from the frame.

The parameters of this traysegment have the same types and meanings as the parameters of the icecube.common_variables.time_characteristics.I3TimeCharacteristicsCalculator icetray module.

It will create one tableio table having the name specified through the OutputI3TimeCharacteristicsValuesName keyword argument.

Return list:

The list of tableio converter keys.