artemis.algorithms.dummyalgo

Example algorithm class.

Module Contents

class artemis.algorithms.dummyalgo.DummyAlgo1(name, **kwargs)

Bases: artemis.core.algo.AlgoBase

Dummy Algorithm use a template for writing User-defined algorithms UDA

__logger

logging managed by framework

Type

Logger

gate

access to histograms, metadata, and stores

Type

ArtemisGateSvc

Parameters

name (str) – Name of algorithm as configured in the metadata

Returns

• Exceptions

• ———-

Examples

initialize(self)

Additional initialization as defined by the user can be done here.

book(self)

Book all histograms that will be used in this algorithm. Histogram names will be modified with the algorithm name.

execute(self, element)

Execute operations on data that is associated with a node in the process graph.

Parameters

element (Element) – Element provides a reference to data that is managed in a common memory store (key-value).

finalize(self)

Any postprocessing at the end of the job, such as creating summary information is done here.