Move from Associations to Links

converter/include/k4SimDelphes/DelphesEDM4HepConverter.h

@@ -1,13 +1,13 @@
 #ifndef DELPHESEDM4HEP_DELPHESEDM4HEP_CONVERTER_H__
 #define DELPHESEDM4HEP_DELPHESEDM4HEP_CONVERTER_H__
 
-// podio
-#include "podio/CollectionBase.h"
-
 // edm4hep
 #include "edm4hep/MCParticle.h"
-#include "edm4hep/MCRecoParticleAssociationCollection.h"
 #include "edm4hep/MutableReconstructedParticle.h"
+#include "edm4hep/RecoMCParticleLinkCollection.h"
+
+// podio
+#include "podio/CollectionBase.h"
 
 // ROOT
 #include "TClonesArray.h"
@@ -68,7 +68,7 @@ namespace k4SimDelphes {
     std::string className;
   };
 
-  std::vector<BranchSettings> getBranchSettings(ExRootConfParam /*const&*/ treeConf) {
+  inline std::vector<BranchSettings> getBranchSettings(ExRootConfParam /*const&*/ treeConf) {
     std::vector<k4SimDelphes::BranchSettings> branches;
     for (int b = 0; b < treeConf.GetSize(); b += 3) {
       k4SimDelphes::BranchSettings branch{treeConf[b].GetString(), treeConf[b + 1].GetString(),
@@ -102,7 +102,7 @@ namespace k4SimDelphes {
      */
     CollectionMapT getCollections() { return std::move(m_collections); }
 
-    edm4hep::MCRecoParticleAssociationCollection* createExternalRecoAssociations(
+    edm4hep::RecoMCParticleLinkCollection* createExternalRecoMCLinks(
         const std::unordered_map<UInt_t, edm4hep::MCParticle>& mc_map);
 
   private:
@@ -159,7 +159,7 @@ namespace k4SimDelphes {
 
     std::string m_recoCollName;
     std::string m_particleIDName;
-    std::string m_mcRecoAssocCollName;
+    std::string m_recoMCLinkCollName;
 
     // map from UniqueIDs (delphes generated particles) to MCParticles
     std::unordered_map<UInt_t, edm4hep::MCParticle> m_genParticleIds;

converter/include/k4SimDelphes/DelphesEDM4HepOutputConfiguration.h

@@ -4,6 +4,7 @@
 #include "ExRootAnalysis/ExRootConfReader.h"
 
 #include <iomanip>
+#include <iostream>
 #include <ostream>
 #include <string>
 #include <vector>
@@ -77,10 +78,10 @@ namespace k4SimDelphes {
     std::string RecoParticleCollectionName{"ReconstructedParticles"};
 
     /**
-     * Name of the MCRecoParticleAssociationCollection holding the associations of
+     * Name of the RecoMCParticleLinkCollection holding the links of
      * generated to reconstructed particles.
      */
-    std::string MCRecoAssociationCollectionName{"MCRecoAssociations"};
+    std::string RecoMCParticleLinkCollectionName{"MCRecoAssociations"};
 
     /**
      * Name of the ParticleIDCollection holding the ctags / isolation variables.
@@ -112,7 +113,7 @@ namespace k4SimDelphes {
     os << std::setw(40) << " MissingETCollections: " << settings.MissingETCollections << "\n";
     os << std::setw(40) << " ScalarHTCollections: " << settings.ScalarHTCollections << "\n";
     os << std::setw(40) << " RecoParticleCollectionName: " << settings.RecoParticleCollectionName << "\n";
-    os << std::setw(40) << " MCRecoAssociationCollectionName: " << settings.MCRecoAssociationCollectionName << "\n";
+    os << std::setw(40) << " RecoMCParticleLinkCollectionName: " << settings.RecoMCParticleLinkCollectionName << "\n";
     os << "------------------------------------------------------------\n";
 
     return os;
@@ -155,13 +156,21 @@ namespace k4SimDelphes {
     settings.RecoParticleCollectionName =
         confReader->GetString("EDM4HepOutput::RecoParticleCollectionName", "ReconstructedParticles");
 
-    settings.MCRecoAssociationCollectionName =
-        confReader->GetString("EDM4HepOutput::MCRecoAssociationCollectionName", "MCRecoAssociations");
+    const auto assocName = confReader->GetString("EDM4HepOutput::MCRecoAssociationCollectionName", "not-available");
+    if (assocName != std::string("not-available")) {
+      std::cerr << "WARNING: k4SimDelphes::getEDM4hepOutputSettings | MCRecoAssociationCollectionName is deprecated, "
+                   "use RecoMCParticleLinkCollection instead"
+                << std::endl;
+      settings.RecoMCParticleLinkCollectionName = assocName;
+    }
+
+    settings.RecoMCParticleLinkCollectionName =
+        confReader->GetString("EDM4HepOutput::RecoMCParticleLinkCollectionName", "MCRecoAssociations");
 
     return settings;
   }
 
-  OutputSettings getEDM4hepOutputSettings(const char* confFile) {
+  inline OutputSettings getEDM4hepOutputSettings(const char* confFile) {
     ExRootConfReader confReader{};
     confReader.ReadFile(confFile);
     return getEDM4hepOutputSettings(&confReader);

converter/src/DelphesEDM4HepConverter.cc

@@ -7,9 +7,9 @@
 #include "edm4hep/ClusterCollection.h"
 #include "edm4hep/EventHeaderCollection.h"
 #include "edm4hep/MCParticleCollection.h"
-#include "edm4hep/MCRecoParticleAssociationCollection.h"
 #include "edm4hep/ParticleIDCollection.h"
 #include "edm4hep/RecDqdxCollection.h"
+#include "edm4hep/RecoMCParticleLinkCollection.h"
 #include "edm4hep/ReconstructedParticleCollection.h"
 #include "edm4hep/TrackCollection.h"
 #if __has_include("edm4hep/TrackerHit3DCollection.h")
@@ -80,7 +80,7 @@ namespace k4SimDelphes {
       : m_magneticFieldBz(magFieldBz),
         m_recoCollName(outputSettings.RecoParticleCollectionName),
         m_particleIDName(outputSettings.ParticleIDCollectionName),
-        m_mcRecoAssocCollName(outputSettings.MCRecoAssociationCollectionName) {
+        m_recoMCLinkCollName(outputSettings.RecoMCParticleLinkCollectionName) {
     for (const auto& branch : branches) {
       if (contains(PROCESSING_ORDER, branch.className)) {
         m_branches.push_back(branch);
@@ -224,7 +224,7 @@ namespace k4SimDelphes {
     auto* magFieldCollection = createCollection<podio::UserDataCollection<float>>("magFieldBz");
     magFieldCollection->push_back(m_magneticFieldBz);
 
-    auto* mcRecoRelations = getCollection<edm4hep::MCRecoParticleAssociationCollection>(m_mcRecoAssocCollName);
+    auto* mcRecoRelations = getCollection<edm4hep::RecoMCParticleLinkCollection>(m_recoMCLinkCollName);
     auto* idCollection    = getCollection<edm4hep::ParticleIDCollection>(m_particleIDName);
     auto* trackerHitColl  = getCollection<edm4hep::TrackerHit3DCollection>(TRACKERHIT_OUTPUT_NAME);
 
@@ -279,8 +279,8 @@ namespace k4SimDelphes {
       UInt_t genId = delphesCand->Particle.GetUniqueID();
       if (const auto genIt = m_genParticleIds.find(genId); genIt != m_genParticleIds.end()) {
         auto relation = mcRecoRelations->create();
-        relation.setSim(genIt->second);
-        relation.setRec(cand);
+        relation.setTo(genIt->second);
+        relation.setFrom(cand);
       }
 
       m_recoParticleGenIds.emplace(genId, cand);
@@ -291,7 +291,7 @@ namespace k4SimDelphes {
   void DelphesEDM4HepConverter::processClusters(const TClonesArray* delphesCollection, std::string const& branch) {
     auto* particleCollection = getCollection<edm4hep::ReconstructedParticleCollection>(m_recoCollName);
     auto* clusterCollection  = createCollection<edm4hep::ClusterCollection>(branch);
-    auto* mcRecoRelations    = getCollection<edm4hep::MCRecoParticleAssociationCollection>(m_mcRecoAssocCollName);
+    auto* mcRecoRelations    = getCollection<edm4hep::RecoMCParticleLinkCollection>(m_recoMCLinkCollName);
     auto* calorimeterHitColl = getCollection<edm4hep::CalorimeterHitCollection>(CALORIMETERHIT_OUTPUT_NAME);
 
     for (auto iCand = 0; iCand < delphesCollection->GetEntries(); ++iCand) {
@@ -335,8 +335,8 @@ namespace k4SimDelphes {
       for (const auto genId : getAllParticleIDs(delphesCand)) {
         if (const auto genIt = m_genParticleIds.find(genId); genIt != m_genParticleIds.end()) {
           auto relation = mcRecoRelations->create();
-          relation.setSim(genIt->second);
-          relation.setRec(cand);
+          relation.setTo(genIt->second);
+          relation.setFrom(cand);
         }
 
         m_recoParticleGenIds.emplace(genId, cand);
@@ -489,15 +489,15 @@ namespace k4SimDelphes {
     return {};
   }
 
-  edm4hep::MCRecoParticleAssociationCollection* DelphesEDM4HepConverter::createExternalRecoAssociations(
+  edm4hep::RecoMCParticleLinkCollection* DelphesEDM4HepConverter::createExternalRecoMCLinks(
       const std::unordered_map<UInt_t, edm4hep::MCParticle>& mc_map) {
-    auto mcRecoRelations = new edm4hep::MCRecoParticleAssociationCollection();
+    auto mcRecoRelations = new edm4hep::RecoMCParticleLinkCollection();
     for (const auto& particleID : mc_map) {
       const auto [recoBegin, recoEnd] = m_recoParticleGenIds.equal_range(particleID.first);
       for (auto it = recoBegin; it != recoEnd; ++it) {
         auto relation = mcRecoRelations->create();
-        relation.setSim(particleID.second);
-        relation.setRec(it->second);
+        relation.setTo(particleID.second);
+        relation.setFrom(it->second);
       }
     }
     return mcRecoRelations;
@@ -508,8 +508,8 @@ namespace k4SimDelphes {
     if (m_collections.find(m_recoCollName) == m_collections.end()) {
       createCollection<edm4hep::ReconstructedParticleCollection>(m_recoCollName);
     }
-    if (m_collections.find(m_mcRecoAssocCollName) == m_collections.end()) {
-      createCollection<edm4hep::MCRecoParticleAssociationCollection>(m_mcRecoAssocCollName);
+    if (m_collections.find(m_recoMCLinkCollName) == m_collections.end()) {
+      createCollection<edm4hep::RecoMCParticleLinkCollection>(m_recoMCLinkCollName);
     }
     if (m_collections.find(m_particleIDName) == m_collections.end()) {
       createCollection<edm4hep::ParticleIDCollection>(m_particleIDName);

doc/output_config.md

@@ -88,9 +88,9 @@ The filled collection contains only one element per event.
 
 
 The parameters **`RecoParticleCollectionName`** and
-**`MCRecoAssociationCollectionName`** control the names of the [global
+**`RecoMCParticleLinkCollectionName`** control the names of the [global
 reconstructed particle collection](#reconstructedparticlecollections) and the
-collection with the `MCRecoParticleAssociation`s that can be used to find the
+collection with the `RecoMCParticleLink`s that can be used to find the
 `MCParticle`s associated to `ReconstructedParticle`s (and vice versa).
 
 ## Class conversions
@@ -99,19 +99,19 @@ The following table lists which Delphes classes correspond to which `edm4hep`
 classes. For the conversion the Delphes classes are taken from the `TreeWriter`
 (the `BranchClass` for each `Branch` defined in there)
 
-| Delphes       | `edm4hep`                                         |
-|---------------|---------------------------------------------------|
-| `GenParticle` | `MCParticle`                                      |
-| `Track`       | `ReconstructedParticle` with associated `Track`   |
-| `Tower`       | `ReconstructedParticle` with associated `Cluster` |
-| `Jet`         | `ReconstructedParticle`                           |
-| `Muon`        | `ReconstructedParticle` (subset collection)       |
-| `Electron`    | `ReconstructedParticle` (subset collection)       |
-| `Photon`      | `ReconstructedParticle` (subset collection)       |
-| `MissingET`   | `ReconstructedParticle`                           |
-| `ScalarHT`    | `ParticleID`                                      |
-| `ParticleFlowCandidate`       | `ReconstructedParticle`           |
-| n/a           | `MCRecoParticleAssociation`                       |
+| Delphes                 | `edm4hep`                                         |
+|-------------------------|---------------------------------------------------|
+| `GenParticle`           | `MCParticle`                                      |
+| `Track`                 | `ReconstructedParticle` with associated `Track`   |
+| `Tower`                 | `ReconstructedParticle` with associated `Cluster` |
+| `Jet`                   | `ReconstructedParticle`                           |
+| `Muon`                  | `ReconstructedParticle` (subset collection)       |
+| `Electron`              | `ReconstructedParticle` (subset collection)       |
+| `Photon`                | `ReconstructedParticle` (subset collection)       |
+| `MissingET`             | `ReconstructedParticle`                           |
+| `ScalarHT`              | `ParticleID`                                      |
+| `ParticleFlowCandidate` | `ReconstructedParticle`                           |
+| n/a                     | `RecoMCParticleLink`                              |
 
 All Delphes classes that are not listed here are currently not converted.
 

examples/edm4hep_output_config.tcl

@@ -9,5 +9,5 @@ module EDM4HepOutput EDM4HepOutput {
     add MissingETCollections             MissingET
     add ScalarHTCollections              ScalarHT
     set RecoParticleCollectionName       ReconstructedParticles
-    set MCRecoAssociationCollectionName  MCRecoAssociations
+    set RecoMCParticleLinkCollectionName  MCRecoAssociations
 }