km3modules.common

A collection of commonly used modules.

Module Contents

Classes

Dump() Print the content of the blob.
Delete() Remove specific keys from the blob.
Keep() Keep only specified keys in the blob.
HitCounter() Prints the number of hits
HitCalibrator() A very basic hit calibrator, which requires a Calibration module.
BlobIndexer() Puts an incremented index in each blob for the key ‘blob_index’
StatusBar() Displays the current blob number.
TickTock() Display the elapsed time.
MemoryObserver() Shows the maximum memory usage
Siphon() A siphon to accumulate a given volume of blobs.
km3modules.common.log[source]
class km3modules.common.Dump[source]

Bases:km3pipe.Module

Print the content of the blob.

Parameters:
keys: collection(string), optional [default=None]

Keys to print. If None, print all keys.

full: bool, default=False

Print blob values too, not just the keys?
configure(self)[source]
process(self, blob)[source]
class km3modules.common.Delete[source]

Bases:km3pipe.Module

Remove specific keys from the blob.

Parameters:
keys: collection(string), optional

Keys to remove.
configure(self)[source]
process(self, blob)[source]
class km3modules.common.Keep[source]

Bases:km3pipe.Module

Keep only specified keys in the blob.

Parameters:
keys: collection(string), optional

Keys to keep. Everything else is removed.
configure(self)[source]
process(self, blob)[source]
class km3modules.common.HitCounter[source]

Bases:km3pipe.Module

Prints the number of hits

process(self, blob)[source]
class km3modules.common.HitCalibrator[source]

Bases:km3pipe.Module

A very basic hit calibrator, which requires a Calibration module.

configure(self)[source]
process(self, blob)[source]
class km3modules.common.BlobIndexer[source]

Bases:km3pipe.Module

Puts an incremented index in each blob for the key ‘blob_index’

configure(self)[source]
process(self, blob)[source]
class km3modules.common.StatusBar[source]

Bases:km3pipe.Module

Displays the current blob number.

configure(self)[source]
process(self, blob)[source]
finish(self)[source]
class km3modules.common.TickTock[source]

Bases:km3pipe.Module

Display the elapsed time.

Parameters:
every: int, optional [default=1]

Number of iterations between printout.
configure(self)[source]
process(self, blob)[source]
class km3modules.common.MemoryObserver[source]

Bases:km3pipe.Module

Shows the maximum memory usage

Parameters:
every: int, optional [default=1]

Number of iterations between printout.
process(self, blob)[source]
class km3modules.common.Siphon[source]

Bases:km3pipe.Module

A siphon to accumulate a given volume of blobs.

Parameters:
volume: int

number of blobs to hold

flush: bool

discard blobs after accumulation
configure(self)[source]
process(self, blob)[source]