artemis.core.algo

Algorithms

Module Contents

class artemis.core.algo.AlgoBase(name, **kwargs)

Bases: artemis.core.gate.MetaMixin

classmethod __init_subclass__(cls, **kwargs)

See PEP 487 Essentially acts as a class method decorator

property name(self)

Algorithm name

static load(logger, **kwargs)

Returns the class instance from a dictionary

to_dict(self)

Create json-serialize class to create the algorithm from all properties

name - instance name as found in menu module - where the class algo resides class - concrete class name properties - all the user-defined properties

to_msg(self)

static from_msg(logger, msg)

lock(self)

Lock all properties for algorithm

abstract initialize(self)

Framework initialize

abstract book(self)

Book histograms

abstract rebook(self)

Rebook with new binnings

abstract execute(self, payload)

Algo always accepts the output Node on a graph Data is accessed via the Parent.payload

abstract finalize(self)

report timings, counters, etc..

class artemis.core.algo.IOAlgoBase(name, **kwargs)

Bases: artemis.core.gate.MetaMixin, artemis.core.gate.IOMetaMixin

property name(self)

Algorithm name

static load(logger, **kwargs)

Returns the class instance from a dictionary

to_dict(self)

Create json-serialize class to create the algorithm from all properties

name - instance name as found in menu module - where the class algo resides class - concrete class name properties - all the user-defined properties

to_msg(self)

static from_msg(logger, msg)

lock(self)

Lock all properties for algorithm

abstract initialize(self)

Framework initialize

abstract book(self)

Book histograms

abstract rebook(self)

Rebook with new binnings

abstract execute(self, payload)

Algo always accepts the output Node on a graph Data is accessed via the Parent.payload

abstract finalize(self)

report timings, counters, etc..