From c4d1d8bda43d0929b3ede3bffe35e60d35c76314 Mon Sep 17 00:00:00 2001
From: Markus Frank <Markus.Frank@cern.ch>
Date: Tue, 6 Dec 2022 17:44:50 +0100
Subject: [PATCH] Improve DDDigi doc
---
DDDigi/README.md | 66 ++++++++++++++++++++++++++----------------------
1 file changed, 36 insertions(+), 30 deletions(-)
diff --git a/DDDigi/README.md b/DDDigi/README.md
index 04e30435c..9f6d191cc 100644
--- a/DDDigi/README.md
+++ b/DDDigi/README.md
@@ -60,8 +60,8 @@ DDDigi Components Description
DigiDDG4ROOT
------------
- Reader for ROOT files produced with DDG4. <br/>
- Properties: <br/>
+- Reader for ROOT files produced with DDG4. <br/>
+ Properties: <br/>
|**Property** |**Data type** |**Description** |
|:--- |:--- |:--- |
@@ -79,32 +79,34 @@ DigiDDG4ROOT
DigiEventAction
---------------
- Generic event level action which can execute workers in parallel
- Properties: <br/>
+- Generic event level action which can execute workers in parallel <br/>
+ Properties: <br/>
|**Property** |**Data type** |**Description** |
|:--- |:--- |:--- |
|`.parallel` | boolean | Flag to indicate parallel action execution |
-- DigiContainerProcessor
+DigiContainerProcessor
+----------------------
- Base class of all actors dealing with one of more containers sequentially.<br/>
+- Base class of all actors dealing with one of more containers sequentially.<br/>
-- DigiContainerSequence
+DigiContainerSequence
+---------------------
+- Sequencer of `DigiContainerProcessor` entities with container based work load splitting.<br/>
- Sequencer of `DigiContainerProcessor` entities with container based work load splitting.<br/>
-
- Properties: <br/>
+ Properties: <br/>
|**Property** |**Data type** |**Description** |
|:--- |:--- |:--- |
|`.parallel` | boolean | Flag to indicate parallel action execution |
-- DigiContainerSequenceAction
+DigiContainerSequenceAction
+---------------------------
- Specialization of the `DigiEventAction`.
+- Specialization of the `DigiEventAction`. <br/>
Process continers from the data store according to the `input_segment` and the `input_mask`.
- Output of workers is delivered to the `output_segment` with mask `output_mask`.
+ Output of workers is delivered to the `output_segment` with mask `output_mask`. <br/>
- Properties: Properties of the `DigiEventAction` apply!<br/>
+ Properties: Properties of the `DigiEventAction` apply! <br/>
|**Property** |**Data type** |**Description** |
|:--- |:--- |:--- |
@@ -113,13 +115,15 @@ DigiEventAction
|`.output_segment`| string | Name of the output data segment |
|`.output_mask` | integer | Mask identifier of the output containers |
-- DigiMultiContainerProcessor
+DigiMultiContainerProcessor
+---------------------------
- Specialization of the `DigiEventAction`.
- Process multiple containers from the data store according to the `input_segment` and the list of `input_masks`. Allows to re-use the same container action.
- Output of workers is delivered to the `output_segment` with mask `output_mask`.
+- Specialization of the `DigiEventAction`.
+ Process multiple containers from the data store according to the `input_segment`
+ and the list of `input_masks`. Allows to re-use the same container action.
+ Output of workers is delivered to the `output_segment` with mask `output_mask`. <br/>
- Properties: Properties of the `DigiEventAction` apply!<br/>
+ Properties: Properties of the `DigiEventAction` apply! <br/>
|**Property** |**Data type** |**Description** |
|:--- |:--- |:--- |
@@ -128,19 +132,21 @@ DigiEventAction
|`.output_segment`| string | Name of the output data segment |
|`.output_mask` | integer | Mask identifier of the output containers |
-- DigiAttenuator
+DigiAttenuator
+--------------
- Deposit attenuator for energy deposits according to decay time constant. <br/>
- Action functor of the `DigiAttenuatorSequence` <br/>
- Properties: Properties of the `DigiContainerSequenceProcessor` apply! <br/>
- |**Property** |**Data type** |**Description** |
- |:--- |:--- |:--- |
- |`.factor` | double | Signal reduction factor applied to all entries processed |
-
-- DigiAttenuatorSequence
+- Deposit attenuator for energy deposits according to decay time constant. <br/>
+ Action functor of the `DigiAttenuatorSequence` <br/>
+ Properties: Properties of the `DigiContainerSequenceProcessor` apply! <br/>
+ |**Property** |**Data type** |**Description** |
+ |:--- |:--- |:--- |
+ |`.factor` | double | Signal reduction factor applied to all entries processed |
+
+DigiAttenuatorSequence
+----------------------
- Container sequencer to attenuate a list of containers.
- Properties: Properties of the `DigiContainerSequenceAction` apply! <br/>
+- Container sequencer to attenuate a list of containers. <br/>
+ Properties: Properties of the `DigiContainerSequenceAction` apply! <br/>
|**Property** |**Data type** |**Description** |
|:--- |:--- |:--- |
|`.processor_type`| string | Processor type used for single container attenuation. |
--
GitLab