Project common_variables

Invoke with: import icecube.common_variables

Python I3Modules

I3DirectHitsCalculator

I3DirectHitsCalculator (Python I3Module)

This icetray module calculates the common event variables for direct hits. A hit is considered direct when the time residual falls within a specified time window. The time residual is defined as the observed time of a hit minus the expected time, based on a track emitting light at the Cherenkov angle.

Param DirectHitsDefinitionSeries:

Default = <icecube._CommonVariables.I3DirectHitsDefinitionSeries object at 0x10b439460>, An I3DirectHitsDefinitionSeries object or a Python list of I3DirectHitsDefinition objects defining the time windows for the direct hits calculation.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3DirectHitsValuesBaseName:

Default = '', The base name of the output I3DirectHitsValues frame objects.

Param ParticleName:

Default = '', The frame object name of the reconstructed particle used as track in the direct hits calculation.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to identify the hits.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

I3HitMultiplicityCalculator

I3HitMultiplicityCalculator (Python I3Module)

This icetray module calculates the hit multiplicity variables, e.g. NHitStrings, NHitDoms, NHitDomsOnePulse, and NPulses.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3HitMultiplicityValuesName:

Default = '', The name of the output I3HitMultiplicityValues frame object.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to calculate the hit multiplicity values.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

I3HitStatisticsCalculator

I3HitStatisticsCalculator (Python I3Module)

This icetray module calculates the hit statistics variables, e.g. COG, PulseTimeSpan, QMinDoms, QMaxDoms, QTotPulses, ZMean, ZSigma, and ZTravel.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3HitStatisticsValuesName:

Default = '', The name of the output I3HitStatisticsValues frame object.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to calculate the hit statistics values.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

I3TimeCharacteristicsCalculator

I3TimeCharacteristicsCalculator (Python I3Module)

This icetray module calculates the time_characteristics cut variables for a given I3Geometry, a given I3RecoPulseSeriesMap.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3TimeCharacteristicsValuesName:

Default = '', The name of the output I3TimeCharacteristicsValues frame object holding the calculation results.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to identify the hits.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

I3TrackCharacteristicsCalculator

I3TrackCharacteristicsCalculator (Python I3Module)

This icetray module calculates the track characteristics cut variables for a given I3Geometry, a given I3RecoPulseSeriesMap, and a given track (given through an I3Particle object).

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3TrackCharacteristicsValuesName:

Default = '', The name of the output I3TrackCharacteristicsValues frame object holding the calculation results.

Param ParticleName:

Default = '', The frame object name of the reconstructed particle used as track for the calculation of the track characteristics.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to identify the hits.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

Param TrackCylinderRadius:

Default = 150.0, The cylinder radius around the track. Only pulses within this cylinder radius around the track will be considered for the calculation of the track characteristics variables.

I3Tray segments

I3DirectHitsCalculatorSegment

I3DirectHitsCalculatorSegment (I3Tray segment)

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

Param BookIt:

Default = False, The switch if this tray segment should also generate and return the tableio converter keys for the calculated direct hits. The name of the output tableio table for the calculated hits will be the same as the name of the frame object holding the calculation results. Default value is False.

Param DirectHitsDefinitionSeries:

Default = <icecube._CommonVariables.I3DirectHitsDefinitionSeries object at 0x10b439cb0>, An I3DirectHitsDefinitionSeries object or a Python list of I3DirectHitsDefinition objects defining the time windows for the direct hits calculation.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3DirectHitsValuesBaseName:

Default = '', The base name of the output I3DirectHitsValues frame objects.

Param ParticleName:

Default = '', The frame object name of the reconstructed particle used as track in the direct hits calculation.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to identify the hits.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

I3DirectHitsValuesBookerSegment

I3DirectHitsValuesBookerSegment (I3Tray segment)

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

Param DirectHitsDefinitionSeries:

Default = None,

Param OutputI3DirectHitsValuesBaseName:

Default = None,

I3HitMultiplicityCalculatorSegment

I3HitMultiplicityCalculatorSegment (I3Tray segment)

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:

Param BookIt:

Default = False, 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.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3HitMultiplicityValuesName:

Default = '', The name of the output I3HitMultiplicityValues frame object.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to calculate the hit multiplicity values.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

I3HitMultiplicityValuesBookerSegment

I3HitMultiplicityValuesBookerSegment (I3Tray segment)

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

Param OutputI3HitMultiplicityValuesName:

Default = None, The name of the icecube.common_variables.hit_multiplicity.I3HitMultiplicityValues object inside the frame.

I3HitStatisticsCalculatorSegment

I3HitStatisticsCalculatorSegment (I3Tray segment)

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:

Param BookIt:

Default = False, 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.

Param COGBookRefFrame:

Default = icecube._tableio_dataclasses.BookRefFrame.Car, The specifier of the reference frame into which the COG position should be booked. Default value is dataclasses.converters.I3PositionConverter.BookRefFrame.Car.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3HitStatisticsValuesName:

Default = '', The name of the output I3HitStatisticsValues frame object.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to calculate the hit statistics values.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

I3HitStatisticsValuesBookerSegment

I3HitStatisticsValuesBookerSegment (I3Tray segment)

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

Param OutputI3HitStatisticsValuesName:

Default = None, The name of the icecube.common_variables.hit_statistics.I3HitStatisticsValues object inside the frame.

Param COGBookRefFrame:

Default = icecube._tableio_dataclasses.BookRefFrame.Car, The specifier of the reference frame in which the COG position values should be booked. Default value is dataclasses.converters.I3PositionConverter.BookRefFrame.Car.

I3TimeCharacteristicsCalculatorSegment

I3TimeCharacteristicsCalculatorSegment (I3Tray segment)

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:

Param BookIt:

Default = False, 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.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3TimeCharacteristicsValuesName:

Default = '', The name of the output I3TimeCharacteristicsValues frame object holding the calculation results.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to identify the hits.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

I3TimeCharacteristicsValuesBookerSegment

I3TimeCharacteristicsValuesBookerSegment (I3Tray segment)

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

Param OutputI3TimeCharacteristicsValuesName:

Default = None,

I3TrackCharacteristicsCalculatorSegment

I3TrackCharacteristicsCalculatorSegment (I3Tray segment)

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

Param BookIt:

Default = False, The switch if this tray segment should also generate and return the tableio converter keys for the generated icecube.common_variables.track_chara cteristics.I3TrackCharacteristicsValues frame object. The name of the output tableio table for the generated I3TrackCharacteristicsValues frame object will be the same as the name of the I3TrackCharacteristicsValues frame object holding the track characteristics cut variables. Default value is False.

Param IcePickServiceKey:

Default = '', Key for an IcePick in the context that this module should check before processing physics frames.

Param If:

Default = None, A python function… if this returns something that evaluates to True, Module runs, else it doesn’t

Param OutputI3TrackCharacteristicsValuesName:

Default = '', The name of the output I3TrackCharacteristicsValues frame object holding the calculation results.

Param ParticleName:

Default = '', The frame object name of the reconstructed particle used as track for the calculation of the track characteristics.

Param PulseSeriesMapName:

Default = '', The frame object name of the pulse series map used to identify the hits.

Param PyLogLevel:

Default = 30, The Python logging module log level for this module.

Param TrackCylinderRadius:

Default = 150.0, The cylinder radius around the track. Only pulses within this cylinder radius around the track will be considered for the calculation of the track characteristics variables.

I3TrackCharacteristicsValuesBookerSegment

I3TrackCharacteristicsValuesBookerSegment (I3Tray segment)

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

Param OutputI3TrackCharacteristicsValuesName:

Default = None,

TableIO converters

I3TimeCharacteristicsValuesConverter

icecube.common_variables.I3TimeCharacteristicsValuesConverter (TableIO converter)

The I3TimeCharacteristicsValues tableio converter converts an I3TimeCharacteristicsValues frame object into a data table verbatim.