Skip to content

Commit b41dc60

Browse files
committed
updated branches doc
1 parent a9307d5 commit b41dc60

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

doc/branches.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,20 +109,24 @@ Calorimeter hits store crystal position in (x,y,z) with frame origin at tracker
109109
| calodigis | Vector branch | raw calorimeter digis with waveform data and parent recodi index| `SiPMID_`, `diskID_`, `t0_` (first sample time), `waveform_`, `peakpos_` (peak index), `posX_`, `posY_`, `caloRecoDigiIdx_` | [see CaloDigiInfo.hh](../inc/CaloDigiInfo.hh)
110110
## Calorimeter MC Branches
111111

112-
The calorimeter MC branches provide MC-truth information aligned with reconstructed clusters and hits.
112+
The calorimeter MC branches provide MC-truth information at different levels of the calorimeter reconstruction hierarchy.
113113

114-
**Cluster MC Information:**
115-
The `caloclustersmc` branch is a vector of MC clusters associated with reconstructed clusters.
116-
The vector is aligned with `caloclusters` (same size & indices), with each element corresponding to true particles depositing energy.
114+
**Alignment with Reconstruction Branches:**
115+
MC information branches are aligned with their corresponding reco branches:
116+
- `caloclustersmc` ← aligned with `caloclusters` (same size & indices)
117+
- `calohitsmc` ← aligned with `calohits` (same size & indices)
118+
- `calodigismc` ← aligned with `calodigis` (same size & indices; raw digi MC truth) (also: `calorecodigis` too)
119+
- `calodigisim` ← unique SimParticles from raw digis
120+
- `calomcsim` ← unique SimParticles from MC clusters
117121

118-
**Particle Information:**
119-
The `calomcsim` branch contains all unique SimParticles that contributed to calorimeter clusters across the entire event.
120-
This branch can be populated from either the `caloclusters` branch or by tracing MC truth back through the `calodigis` branch (both paths contain the necessary SimParticle information).
121-
Each MC particle is indexed via the `simParticleIds` field in the MC cluster/hit or digi.
122+
Each MC element contains `simParticleIds` to index into the corresponding `*mcsim` branch for genealogy information.
122123

123124
| branch | structure | explanation | key fields | leaf information |
124125
|--------|-----------|-------------|-----------|------------------|
125126
| caloclustersmc | Vector branch | MC-truth information for calorimeter clusters (aligned with caloclusters)| `nsim` (# of sim particles), `etot` (total true energy), `tavg` (avg time), `eprimary` (primary particle energy), `tprimary` (primary time), `simParticleIds`, `simRels` (MCRelationship), `hits_`, `prel` (primary to event primary relationship) | [see CaloClusterInfoMC.hh](../inc/CaloClusterInfoMC.hh)
127+
| calohitsmc | Vector branch | MC-truth information for calorimeter hits (aligned with calohits)| `nsim`, `eDep`, `eDepG4`, `eprimary`, `tprimary`, `eDeps`, `tDeps`, `momentumIns`, `simParticleIds`, `simRels`, `caloClusterIdx_`, etc. | [see CaloHitInfoMC.hh](../inc/CaloHitInfoMC.hh)
128+
| calodigismc | Vector branch | MC-truth information for raw calorimeter digis (aligned with calodigis)| `nsim`, `eDep`, `eDepG4`, `eprimary`, `tprimary`, `eDeps`, `tDeps`, `momentumIns`, `simParticleIds`, `simRels`, `caloHitIdx_`, `crystalID_`, `diskID_`, `energyCorr_`, `timeCorr_`, `posX_`, `posY_` | [see CaloDigiMCInfo.hh](../inc/CaloDigiMCInfo.hh)
129+
| calodigisim | Vector branch | unique SimParticles in all raw digis (genealogy information)| SimParticle genealogy info | [see SimInfo.hh](../inc/SimInfo.hh)
126130
| calomcsim | Vector branch | unique SimParticles in all MC clusters (genealogy information)| SimParticle genealogy info | [see SimInfo.hh](../inc/SimInfo.hh)
127131
## CRV Branches
128132

0 commit comments

Comments
 (0)