Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions DataFormats/Common/interface/MultiSpan.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@

#include <algorithm>
#include <cassert>
#include <ranges>
#include <span>
#include <stdexcept>
#include <vector>

#include "DataFormats/Common/interface/RefProd.h"
#include "DataFormats/Common/interface/RefProdVector.h"

namespace edm {

/**
Expand All @@ -29,6 +33,13 @@ namespace edm {
public:
MultiSpan() = default;

MultiSpan(const RefProdVector<std::vector<T>>& refProducts) {
std::ranges::for_each(refProducts, [&](auto const& rp) {
if (rp.isNonnull())
add(*rp);
});
}

void add(std::span<const T> sp) {
// Empty spans are not added to reduce the number of spans and speed up the binary search
if (sp.empty()) {
Expand Down
13 changes: 13 additions & 0 deletions DataFormats/Common/interface/RefProdVector.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#ifndef DataFormats_Common_interface_RefProdVector_h
#define DataFormats_Common_interface_RefProdVector_h

#include <vector>

#include "DataFormats/Common/interface/RefProd.h"

namespace edm {
template <typename T>
using RefProdVector = std::vector<edm::RefProd<T>>;
} // namespace edm

#endif // DataFormats_Common_interface_RefProdVector_h
36 changes: 36 additions & 0 deletions DataFormats/Common/test/test_catch2_MultiSpan.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
#include <catch2/catch_all.hpp>

#include "DataFormats/Common/interface/MultiSpan.h"
#include "DataFormats/Common/interface/RefProd.h"
#include "DataFormats/Common/interface/RefProdVector.h"

TEST_CASE("MultiSpan basic indexing", "[MultiSpan]") {
edm::MultiSpan<int> emptyMultiSpan;
Expand Down Expand Up @@ -37,6 +39,18 @@ TEST_CASE("MultiSpan basic indexing", "[MultiSpan]") {
ms3.add(a);
ms3.add(c);

edm::RefProdVector<std::vector<int>> refProducts;
refProducts.push_back(edm::RefProd<std::vector<int>>(&b));
refProducts.push_back(edm::RefProd<std::vector<int>>(&c));
refProducts.push_back(edm::RefProd<std::vector<int>>(&c));
refProducts.push_back(edm::RefProd<std::vector<int>>(&c));
refProducts.push_back(edm::RefProd<std::vector<int>>(&b));
refProducts.push_back(edm::RefProd<std::vector<int>>(&a));
refProducts.push_back(edm::RefProd<std::vector<int>>(&c));
refProducts.push_back(
edm::RefProd<std::vector<int>>(nullptr)); // Adding a null RefProd. It should be ignored by MultiSpan
edm::MultiSpan<int> ms4(refProducts); // MultiSpan from std::vector of RefProds<std::vector>

using ElementType = decltype(ms[0]);
// Check that the const-correctness of the MultiSpan
static_assert(!std::is_assignable<ElementType, int>::value,
Expand Down Expand Up @@ -175,4 +189,26 @@ TEST_CASE("MultiSpan basic indexing", "[MultiSpan]") {
}
REQUIRE(collected == std::vector<int>{a[0], a[1], a[2]});
}

SECTION("Check MultiSpan constructed from std::vector of RefProds<std::vector>") {
REQUIRE(ms4.size() == 7);

REQUIRE(ms4[0] == b[0]);
REQUIRE(ms4[1] == b[1]);
REQUIRE(ms4[2] == b[0]);
REQUIRE(ms4[3] == b[1]);
REQUIRE(ms4[4] == a[0]);
REQUIRE(ms4[5] == a[1]);
REQUIRE(ms4[6] == a[2]);

REQUIRE(ms4.globalIndex(0, 0) == 0);
REQUIRE(ms4.globalIndex(1, 1) == 3);
REQUIRE(ms4.globalIndex(2, 1) == 5);

std::vector<int> collected;
for (auto val : ms4) {
collected.push_back(val);
}
REQUIRE(collected == std::vector<int>{b[0], b[1], b[0], b[1], a[0], a[1], a[2]});
}
}
5 changes: 4 additions & 1 deletion DataFormats/HGCRecHit/src/classes_def.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@
<class name="edm::Ref<edm::SortedCollection<HGCRecHit,edm::StrictWeakOrdering<HGCRecHit> >,HGCRecHit,edm::refhelper::FindUsingAdvance<edm::SortedCollection<HGCRecHit,edm::StrictWeakOrdering<HGCRecHit> >,HGCRecHit> >"/>
<class name="edm::RefVector<edm::SortedCollection<HGCRecHit,edm::StrictWeakOrdering<HGCRecHit> >,HGCRecHit,edm::refhelper::FindUsingAdvance<edm::SortedCollection<HGCRecHit,edm::StrictWeakOrdering<HGCRecHit> >,HGCRecHit> >"/>
<class name="edm::RefProd<edm::SortedCollection<HGCRecHit,edm::StrictWeakOrdering<HGCRecHit> > >"/>

<class name="edm::Wrapper<std::vector<edm::RefProd<std::vector<HGCRecHit> > > >"/>
<class name="edm::Wrapper<std::vector<HGCRecHit>>"/>


<class name="edm::RefProd<std::vector<HGCRecHit> >"/>
<class name="vector<edm::RefProd<std::vector<HGCRecHit> > >"/>
<class name="edm::DetSet<HGCRecHit>"/>
<class name="edm::DetSetVector<HGCRecHit>"/>
<class name="std::vector<edm::DetSet<HGCRecHit> >"/>
Expand Down
39 changes: 25 additions & 14 deletions RecoLocalCalo/HGCalRecProducers/plugins/RecHitMapProducer.cc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

#include "DataFormats/HGCRecHit/interface/HGCRecHitCollections.h"
#include "DataFormats/ParticleFlowReco/interface/PFRecHit.h"
#include "DataFormats/Common/interface/RefProdVector.h"
#include "DataFormats/Common/interface/MultiSpan.h"

class RecHitMapProducer : public edm::global::EDProducer<> {
Expand Down Expand Up @@ -43,9 +44,13 @@ RecHitMapProducer::RecHitMapProducer(const edm::ParameterSet& ps) : hgcalOnly_(p
}
}

produces<edm::RefProdVector<HGCRecHitCollection>>("RefProdVectorHGCRecHitCollection");
produces<DetIdRecHitMap>("hgcalRecHitMap");
if (!hgcalOnly_)

if (!hgcalOnly_) {
produces<edm::RefProdVector<reco::PFRecHitCollection>>("RefProdVectorPFRecHitCollection");
produces<DetIdRecHitMap>("barrelRecHitMap");
}
}

void RecHitMapProducer::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
Expand All @@ -69,22 +74,24 @@ void RecHitMapProducer::produce(edm::StreamID, edm::Event& evt, const edm::Event

// Check validity of all handles
if (!ee_hits.isValid() || !fh_hits.isValid() || !bh_hits.isValid()) {
edm::LogWarning("HGCalRecHitMapProducer")
<< "One or more HGCal hit collections are unavailable. Returning an empty map.";
edm::LogWarning("HGCalRecHitMapProducer") << "One or more HGCal hit collections are unavailable. Returning an "
"empty map and an empty RefProdVectorHGCRecHitCollection";
evt.put(std::make_unique<edm::RefProdVector<HGCRecHitCollection>>(), "RefProdVectorHGCRecHitCollection");
evt.put(std::move(hitMapHGCal), "hgcalRecHitMap");
} else {
// TODO may be worth to avoid dependency on the order
// of the collections, maybe using a map
edm::MultiSpan<HGCRecHit> rechitSpan;
rechitSpan.add(*ee_hits);
rechitSpan.add(*fh_hits);
rechitSpan.add(*bh_hits);
// Fix order by storing a edm::RefProdVector<HGCRecHitCollection>
auto mcHGCRecHit = std::make_unique<edm::RefProdVector<HGCRecHitCollection>>();
mcHGCRecHit->push_back(edm::RefProd<HGCRecHitCollection>(ee_hits));
mcHGCRecHit->push_back(edm::RefProd<HGCRecHitCollection>(fh_hits));
mcHGCRecHit->push_back(edm::RefProd<HGCRecHitCollection>(bh_hits));

edm::MultiSpan<HGCRecHit> rechitSpan(*mcHGCRecHit);
for (unsigned int i = 0; i < rechitSpan.size(); ++i) {
const auto recHitDetId = rechitSpan[i].detid();
hitMapHGCal->emplace(recHitDetId, i);
}

evt.put(std::move(mcHGCRecHit), "RefProdVectorHGCRecHitCollection");
evt.put(std::move(hitMapHGCal), "hgcalRecHitMap");
}

Expand All @@ -99,18 +106,22 @@ void RecHitMapProducer::produce(edm::StreamID, edm::Event& evt, const edm::Event
const auto& hbhe_hits = evt.getHandle(barrel_hits_token_[1]);

if (!ecal_hits.isValid() || !hbhe_hits.isValid()) {
edm::LogWarning("HGCalRecHitMapProducer")
<< "One or more barrel hit collections are unavailable. Returning an empty map.";
edm::LogWarning("HGCalRecHitMapProducer") << "One or more barrel hit collections are unavailable. Returning an "
"empty map and an empty RefProdVectorPFRecHitCollection";
evt.put(std::make_unique<edm::RefProdVector<reco::PFRecHitCollection>>(), "RefProdVectorPFRecHitCollection");
evt.put(std::move(hitMapBarrel), "barrelRecHitMap");
} else {
edm::MultiSpan<reco::PFRecHit> barrelRechitSpan;
barrelRechitSpan.add(evt.get(barrel_hits_token_[0]));
barrelRechitSpan.add(evt.get(barrel_hits_token_[1]));
auto mcPFRecHit = std::make_unique<edm::RefProdVector<reco::PFRecHitCollection>>();
mcPFRecHit->push_back(edm::RefProd<reco::PFRecHitCollection>(ecal_hits));
mcPFRecHit->push_back(edm::RefProd<reco::PFRecHitCollection>(hbhe_hits));

edm::MultiSpan<reco::PFRecHit> barrelRechitSpan(*mcPFRecHit);
for (unsigned int i = 0; i < barrelRechitSpan.size(); ++i) {
const auto recHitDetId = barrelRechitSpan[i].detId();
hitMapBarrel->emplace(recHitDetId, i);
}

evt.put(std::move(mcPFRecHit), "RefProdVectorPFRecHitCollection");
evt.put(std::move(hitMapBarrel), "barrelRecHitMap");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
"particleFlowRecHitHBHE"]

from Configuration.ProcessModifiers.ticl_barrel_cff import ticl_barrel
ticl_barrel.toModify(recHitMapProducer, hits = hits, hgcalOnly = False)
ticl_barrel.toModify(recHitMapProducer, hits = hits, hgcalOnly = False)
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
#include "DataFormats/CaloRecHit/interface/CaloCluster.h"
#include "SimDataFormats/Associations/interface/TICLAssociationMap.h"
#include "DataFormats/HGCRecHit/interface/HGCRecHitCollections.h"
#include "DataFormats/Common/interface/RefProdVector.h"
#include "DataFormats/Common/interface/MultiSpan.h"

class AllHitToTracksterAssociatorsProducer : public edm::global::EDProducer<> {
Expand All @@ -25,22 +26,19 @@ class AllHitToTracksterAssociatorsProducer : public edm::global::EDProducer<> {
std::vector<std::pair<std::string, edm::EDGetTokenT<std::vector<ticl::Trackster>>>> tracksterCollectionTokens_;
edm::EDGetTokenT<std::vector<reco::CaloCluster>> layerClustersToken_;
edm::EDGetTokenT<std::unordered_map<DetId, const unsigned int>> hitMapToken_;
std::vector<edm::EDGetTokenT<HGCRecHitCollection>> hitsTokens_;
edm::EDGetTokenT<edm::RefProdVector<HGCRecHitCollection>> hitsToken_;
};

AllHitToTracksterAssociatorsProducer::AllHitToTracksterAssociatorsProducer(const edm::ParameterSet& pset)
: layerClustersToken_(consumes<std::vector<reco::CaloCluster>>(pset.getParameter<edm::InputTag>("layerClusters"))),
hitMapToken_(
consumes<std::unordered_map<DetId, const unsigned int>>(pset.getParameter<edm::InputTag>("hitMapTag"))) {
consumes<std::unordered_map<DetId, const unsigned int>>(pset.getParameter<edm::InputTag>("hitMapTag"))),
hitsToken_(consumes<edm::RefProdVector<HGCRecHitCollection>>(pset.getParameter<edm::InputTag>("hits"))) {
const auto& tracksterCollections = pset.getParameter<std::vector<edm::InputTag>>("tracksterCollections");
for (const auto& tag : tracksterCollections) {
tracksterCollectionTokens_.emplace_back(tag.label() + tag.instance(), consumes<std::vector<ticl::Trackster>>(tag));
}

for (const auto& tag : pset.getParameter<std::vector<edm::InputTag>>("hits")) {
hitsTokens_.emplace_back(consumes<HGCRecHitCollection>(tag));
}

for (const auto& tracksterToken : tracksterCollectionTokens_) {
produces<ticl::AssociationMap<ticl::mapWithFraction>>("hitTo" + tracksterToken.first);
produces<ticl::AssociationMap<ticl::mapWithFraction>>(tracksterToken.first + "ToHit");
Expand All @@ -65,20 +63,25 @@ void AllHitToTracksterAssociatorsProducer::produce(edm::StreamID, edm::Event& iE
Handle<std::unordered_map<DetId, const unsigned int>> hitMap;
iEvent.getByToken(hitMapToken_, hitMap);

edm::MultiSpan<HGCRecHit> rechitSpan;
for (const auto& token : hitsTokens_) {
Handle<HGCRecHitCollection> hitsHandle;
iEvent.getByToken(token, hitsHandle);
if (!iEvent.getHandle(hitsToken_)) {
edm::LogWarning("AllHitToTracksterAssociatorsProducer") << "Missing edm::RefProdVector<HGCRecHitCollection>.";
for (const auto& tracksterToken : tracksterCollectionTokens_) {
iEvent.put(std::make_unique<ticl::AssociationMap<ticl::mapWithFraction>>(), "hitTo" + tracksterToken.first);
iEvent.put(std::make_unique<ticl::AssociationMap<ticl::mapWithFraction>>(), tracksterToken.first + "ToHit");
}
return;
}

// Protection against missing HGCRecHitCollection
if (!hitsHandle.isValid()) {
edm::LogWarning("AllHitToTracksterAssociatorsProducer")
<< "Missing HGCRecHitCollection for one of the hitsTokens.";
continue;
// Protection against missing HGCRecHitCollection
const auto hits = iEvent.get(hitsToken_);
for (std::size_t index = 0; const auto& hgcRecHitCollection : hits) {
if (hgcRecHitCollection->empty()) {
edm::LogWarning("AllHitToTracksterAssociatorsProducer") << "HGCRecHitCollections #" << index << " is not valid.";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The producers, that have been adapted in the PR contain a few debug evaluations. They have not beed guarded by NDEBUG so far, should this be done?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guarding with NDEBUG won't have much effect in practice because by default CMSSW is built with NDEBUG defined.

}
rechitSpan.add(*hitsHandle);
index++;
}

edm::MultiSpan<HGCRecHit> rechitSpan(hits);
// Check if rechitSpan is empty
if (rechitSpan.size() == 0) {
edm::LogWarning("HitToSimClusterCaloParticleAssociatorProducer")
Expand Down Expand Up @@ -135,10 +138,7 @@ void AllHitToTracksterAssociatorsProducer::fillDescriptions(edm::ConfigurationDe
edm::InputTag("ticlCandidate")});
desc.add<edm::InputTag>("layerClusters", edm::InputTag("hgcalMergeLayerClusters"));
desc.add<edm::InputTag>("hitMapTag", edm::InputTag("recHitMapProducer", "hgcalRecHitMap"));
desc.add<std::vector<edm::InputTag>>("hits",
{edm::InputTag("HGCalRecHit", "HGCEERecHits"),
edm::InputTag("HGCalRecHit", "HGCHEFRecHits"),
edm::InputTag("HGCalRecHit", "HGCHEBRecHits")});
desc.add<edm::InputTag>("hits", edm::InputTag("recHitMapProducer", "RefProdVectorHGCRecHitCollection"));
descriptions.add("AllHitToTracksterAssociatorsProducer", desc);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
#include "SimDataFormats/Associations/interface/TICLAssociationMap.h"
#include "DataFormats/Provenance/interface/ProductID.h"
#include "DataFormats/HGCRecHit/interface/HGCRecHitCollections.h"
#include "DataFormats/Common/interface/RefProdVector.h"
#include "DataFormats/Common/interface/MultiSpan.h"
#include "DataFormats/CaloRecHit/interface/CaloCluster.h"
#include "SimDataFormats/CaloAnalysis/interface/CaloParticle.h"
Expand Down Expand Up @@ -37,15 +38,16 @@ class AllTracksterToSimTracksterAssociatorsByHitsProducer : public edm::global::
std::vector<std::pair<std::string, edm::EDGetTokenT<ticl::AssociationMap<ticl::mapWithFraction>>>>
simTracksterToHitMapTokens_;

std::vector<edm::EDGetTokenT<HGCRecHitCollection>> hitsTokens_;
edm::EDGetTokenT<edm::RefProdVector<HGCRecHitCollection>> hitsToken_;
edm::EDGetTokenT<std::vector<CaloParticle>> caloParticleToken_;
edm::EDGetTokenT<ticl::AssociationMap<ticl::mapWithFraction>> hitToSimClusterMapToken_;
edm::EDGetTokenT<ticl::AssociationMap<ticl::mapWithFraction>> hitToCaloParticleMapToken_;
};

AllTracksterToSimTracksterAssociatorsByHitsProducer::AllTracksterToSimTracksterAssociatorsByHitsProducer(
const edm::ParameterSet& pset)
: caloParticleToken_(consumes<std::vector<CaloParticle>>(pset.getParameter<edm::InputTag>("caloParticles"))),
: hitsToken_(consumes<edm::RefProdVector<HGCRecHitCollection>>(pset.getParameter<edm::InputTag>("hits"))),
caloParticleToken_(consumes<std::vector<CaloParticle>>(pset.getParameter<edm::InputTag>("caloParticles"))),
hitToSimClusterMapToken_(consumes<ticl::AssociationMap<ticl::mapWithFraction>>(
pset.getParameter<edm::InputTag>("hitToSimClusterMap"))),
hitToCaloParticleMapToken_(consumes<ticl::AssociationMap<ticl::mapWithFraction>>(
Expand Down Expand Up @@ -78,12 +80,6 @@ AllTracksterToSimTracksterAssociatorsByHitsProducer::AllTracksterToSimTracksterA
label, consumes<ticl::AssociationMap<ticl::mapWithFraction>>(edm::InputTag(allHitToTSAccoc, label + "ToHit")));
}

// Hits
auto hitsTags = pset.getParameter<std::vector<edm::InputTag>>("hits");
for (const auto& tag : hitsTags) {
hitsTokens_.push_back(consumes<HGCRecHitCollection>(tag));
}

// Produce separate association maps for each trackster-simTrackster combination
for (const auto& tracksterToken : tracksterCollectionTokens_) {
for (const auto& simTracksterToken : simTracksterCollectionTokens_) {
Expand All @@ -104,19 +100,34 @@ void AllTracksterToSimTracksterAssociatorsByHitsProducer::produce(edm::StreamID,
const edm::EventSetup&) const {
using namespace edm;

edm::MultiSpan<HGCRecHit> rechitSpan;
for (const auto& token : hitsTokens_) {
Handle<HGCRecHitCollection> hitsHandle;
iEvent.getByToken(token, hitsHandle);
if (!iEvent.getHandle(hitsToken_).isValid()) {
edm::LogWarning("AllTracksterToSimTracksterAssociatorsByHitsProducer") << "Missing MultiHGCRecHitCollection.";
for (const auto& tracksterToken : tracksterCollectionTokens_) {
for (const auto& simTracksterToken : simTracksterCollectionTokens_) {
iEvent.put(std::make_unique<ticl::AssociationMap<ticl::mapWithSharedEnergyAndScore,
std::vector<ticl::Trackster>,
std::vector<ticl::Trackster>>>(),
tracksterToken.first + "To" + simTracksterToken.first);
iEvent.put(std::make_unique<ticl::AssociationMap<ticl::mapWithSharedEnergyAndScore,
std::vector<ticl::Trackster>,
std::vector<ticl::Trackster>>>(),
simTracksterToken.first + "To" + tracksterToken.first);
}
}
return;
}

if (!hitsHandle.isValid()) {
// Protection against missing HGCRecHitCollection
const auto hits = iEvent.get(hitsToken_);
for (std::size_t index = 0; const auto& hgcRecHitCollection : hits) {
if (hgcRecHitCollection->empty()) {
edm::LogWarning("AllTracksterToSimTracksterAssociatorsByHitsProducer")
<< "Missing HGCRecHitCollection for one of the hitsTokens.";
continue;
<< "HGCRecHitCollections #" << index << " is not valid.";
}
rechitSpan.add(*hitsHandle);
index++;
}

edm::MultiSpan<HGCRecHit> rechitSpan(hits);
// Check if rechitSpan is empty
if (rechitSpan.size() == 0) {
edm::LogWarning("AllTracksterToSimTracksterAssociatorsByHitsProducer")
Expand Down Expand Up @@ -465,10 +476,7 @@ void AllTracksterToSimTracksterAssociatorsByHitsProducer::fillDescriptions(
"tracksterCollections", {edm::InputTag("ticlTrackstersCLUE3DHigh"), edm::InputTag("ticlTrackstersLinks")});
desc.add<std::vector<edm::InputTag>>(
"simTracksterCollections", {edm::InputTag("ticlSimTracksters"), edm::InputTag("ticlSimTracksters", "fromCPs")});
desc.add<std::vector<edm::InputTag>>("hits",
{edm::InputTag("HGCalRecHit", "HGCEERecHits"),
edm::InputTag("HGCalRecHit", "HGCHEFRecHits"),
edm::InputTag("HGCalRecHit", "HGCHEBRecHits")});
desc.add<edm::InputTag>("hits", edm::InputTag("recHitMapProducer", "RefProdVectorHGCRecHitCollection"));
desc.add<edm::InputTag>("hitToSimClusterMap",
edm::InputTag("hitToSimClusterCaloParticleAssociator", "hitToSimClusterMap"));
desc.add<edm::InputTag>("hitToCaloParticleMap",
Expand Down
Loading