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.
MultiFilePump	Use the given pump to iterate through a list of files.
LocalDBService	Provides a local sqlite3 based database service to store information
Observer	A simple helper to observe the blobs in a test pipeline.
FilePump	A basic iterator for a list of files.

Attributes

log

km3modules.common.log

class km3modules.common.Dump(name=None, **parameters)

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()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.common.Delete(name=None, **parameters)

Remove specific keys from the blob.

Parameters:

keys: collection(string), optional

Keys to remove.

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.common.Keep(name=None, **parameters)

Keep only specified keys in the blob.

Parameters:

keys: collection(string), optional

Keys to keep. Everything else is removed.

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.common.HitCounter(name=None, **parameters)

Prints the number of hits

process(blob)

Knead the blob and return it

class km3modules.common.HitCalibrator(name=None, **parameters)

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

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.common.BlobIndexer(name=None, **parameters)

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

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.common.StatusBar(name=None, **parameters)

Displays the current blob number.

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

finish()

Clean everything up.

class km3modules.common.TickTock(name=None, **parameters)

Display the elapsed time.

Parameters:

every: int, optional [default=1]

Number of iterations between printout.

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.common.MemoryObserver(name=None, **parameters)

Shows the maximum memory usage

Parameters:

every: int, optional [default=1]

Number of iterations between printout.

process(blob)

Knead the blob and return it

class km3modules.common.Siphon(name=None, **parameters)

A siphon to accumulate a given volume of blobs.

Parameters:

volume: int

number of blobs to hold

flush: bool

discard blobs after accumulation

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

class km3modules.common.MultiFilePump(name=None, **parameters)

Use the given pump to iterate through a list of files.

The group_id will be reset so that it’s unique for each iteration.

Parameters:

pump: Pump

The pump to be used to generate the blobs.

filenames: iterable(str)

List of filenames.

kwargs: dict(str -> any) optional

Keyword arguments to be passed to the pump.

configure()

Configure module, like instance variables etc.

blob_generator()

process(blob)

Knead the blob and return it

finish()

Clean everything up.

class km3modules.common.LocalDBService(name=None, **parameters)

Provides a local sqlite3 based database service to store information

configure()

Configure module, like instance variables etc.

query(query)

Execute a SQL query and return the result of fetchall()

insert_row(table, column_names, values)

Insert a row into the table with a given list of values

create_table(name, columns, types, overwrite=False)

Create a table with given columns and types, overwrite if specified

The types should be a list of SQL types, like [“INT”, “TEXT”, “INT”]

table_exists(name)

Check if a table exists in the database

finish()

Clean everything up.

class km3modules.common.Observer(name=None, **parameters)

A simple helper to observe the blobs in a test pipeline.

Parameters:

count: int

The exact number of iterations the pipeline has to drain

required_keys: list(str)

A list of keys which has to be present in a blob in every cycle.

configure()

Configure module, like instance variables etc.

process(blob)

Knead the blob and return it

finish()

Clean everything up.

class km3modules.common.FilePump(name=None, **parameters)

A basic iterator for a list of files.

Parameters:

filenames: iterable(str)

The filenames to be iterated over which are put into blob["filename"]

configure()

Configure module, like instance variables etc.

blob_generator()

process(blob)

Knead the blob and return it