km3modules.io

Module Contents

Classes

HitsTabulator	Create kp.Table from hits provided by km3io.
MCTracksTabulator	Create kp.Table from MC tracks provided by km3io.
RecoTracksTabulator	Create kp.Table from recostruced tracks provided by km3io.
EventInfoTabulator	Create kp.Table from event information provided by km3io.
OfflineHeaderTabulator	The module which can be attached to the pipeline

Attributes

USR_MC_TRACKS_KEYS

km3modules.io.USR_MC_TRACKS_KEYS = [b'energy_lost_in_can', b'bx', b'by', b'ichan', b'cc']

class km3modules.io.HitsTabulator(name=None, **parameters)

Create kp.Table from hits provided by km3io.

Parameters:

kind: str

The kind of hits to tabulate:

“offline”: the hits in an offline file “online”: snapshot and triggered hits (will be combined) “mc”: MC hits

split: bool (default: True)

Defines whether the hits should be split up into individual arrays in a single group (e.g. hits/dom_id, hits/channel_id) or stored as a single HDF5Compound array (e.g. hits).

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.io.MCTracksTabulator(name=None, **parameters)

Create kp.Table from MC tracks provided by km3io.

Parameters:

split: bool (default: False)

Defines whether the tracks should be split up into individual arrays in a single group (e.g. mc_tracks/by, mc_tracks/origin) or stored as a single HDF5Compound array (e.g. mc_tracks).

read_usr_data: bool (default: False)

Parses usr-data which is originally meant for user stored values, but was abused by generator software to store properties. This issue will be sorted out hopefully soon as it dramatically decreases the processing performance and usability.

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.io.RecoTracksTabulator(name=None, **parameters)

Create kp.Table from recostruced tracks provided by km3io.

Parameters:

best_tracks: bool (default: False)

Additionally determine best track.

split: bool (default: False)

Defines whether the tracks should be split up into individual arrays in a single group (e.g. reco/tracks/dom_id, reco/tracks/channel_id) or stored as a single HDF5Compound array (e.g. reco/tracks).

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.io.EventInfoTabulator(name=None, **parameters)

Create kp.Table from event information provided by km3io.

process(blob)

Knead the blob and return it

class km3modules.io.OfflineHeaderTabulator(name=None, **parameters)

The module which can be attached to the pipeline

process(blob)

Knead the blob and return it