Warning, /tutorial-reconstruction-algorithms/learners/reference.md is written in an unsupported language. File is not indexed.
0001 ---
0002 title: 'Reference'
0003 ---
0004
0005 ## Glossary
0006
0007 Algorithm
0008 : A class that performs one kind of calculation in a generic, framework-independent way. In
0009 EICrecon, algorithms inherit from `algorithms::Algorithm<Input<...>, Output<...>>` and live
0010 under `src/algorithms`.
0011
0012 Factory
0013 : A class that attaches an algorithm to the JANA2 framework, handling inputs, outputs, parameters,
0014 services, and initialization. New factories use `JOmniFactory` and live under `src/factories`.
0015
0016 JANA2
0017 : The event-processing framework used by EICrecon. It manages parallel event processing,
0018 factories, plugins, and services.
0019
0020 JOmniFactory
0021 : The modern JANA2 factory base class used for all new EICrecon factories. It declares its inputs,
0022 outputs, parameters, and services as registered members and uses the Curiously Recurring
0023 Template Pattern.
0024
0025 Factory generator
0026 : A `JOmniFactoryGeneratorT` object that acts as a recipe JANA2 uses to instantiate factories,
0027 assigning each instance a unique prefix and its input/output collection names.
0028
0029 Plugin
0030 : A JANA2 mechanism controlling which parts of EICrecon are compiled and linked. Each detector and
0031 benchmark corresponds to a plugin that registers its factory generators in an `InitPlugin()`
0032 method.
0033
0034 PODIO
0035 : A toolkit that generates data-model classes from a YAML specification. The EIC data model
0036 `edm4eic` (built on `edm4hep`) is implemented with PODIO.
0037
0038 Subset collection
0039 : A PODIO collection that refers to objects owned by another collection without owning them
0040 itself, created with `setSubsetCollection()`.
0041
0042 Config struct
0043 : A plain-old-data struct holding an algorithm's or factory's parameters, exposed to a factory via
0044 `config()` and to an algorithm via the `WithPodConfig` mixin's `m_cfg` member.
