Skip to content

Refactor retrieval of EDM4hep event Frame into method #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmcarcell merged 4 commits into from
Aug 11, 2025
Merged

Refactor retrieval of EDM4hep event Frame into method #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ba533b
Refactor retrieval of EDM4hep event Frame into method
tmadlener May 22, 2025
10f8133
Return a const ref directly instead of wrapping it
tmadlener May 22, 2025
4d4c043
Fill an empty Frame into the TES in case there is none
tmadlener May 23, 2025
6d97ad3
Document assumptions
tmadlener May 23, 2025
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
2 changes: 2 additions & 0 deletions k4MarlinWrapper/k4MarlinWrapper/converters/EDM4hep2Lcio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ class EDM4hep2LcioTool : public AlgTool, virtual public IEDMConverter {
std::vector<EDM4hep2LCIOConv::ParticleIDConvData>& pidCollections,
std::vector<EDM4hep2LCIOConv::TrackDqdxConvData>& dQdxCollections);

const podio::Frame& getEDM4hepEvent() const;

/// Get an EDM4hep collection by name, consulting either the podio based data
/// svc or the IOSvc
podio::CollectionBase* getEDM4hepCollection(const std::string& name) const;
Expand Down
54 changes: 39 additions & 15 deletions k4MarlinWrapper/src/components/EDM4hep2Lcio.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,10 +390,45 @@ void EDM4hep2LcioTool::convertAdd(const std::string& e4h_coll_name, const std::s
}
}

const podio::Frame& EDM4hep2LcioTool::getEDM4hepEvent() const {
debug() << "Retrieving EDM4hep event (Frame)" << endmsg;
if (m_podioDataSvc) {
debug() << "Getting it from PodioDataSvc" << endmsg;
return m_podioDataSvc->getEventFrame();
} else {
debug() << "Trying to get it from TES" << endmsg;
DataObject* p;
StatusCode code = m_eventDataSvc->retrieveObject("/Event" + k4FWCore::frameLocation, p);
if (code.isSuccess()) {
auto* frame = dynamic_cast<AnyDataWrapper<podio::Frame>*>(p);
return frame->getData();
}
}

// We can do this because the following assumptions are true:
// - We only end up here if we are using the IOSvc and we are NOT reading
// EDM4hep data. Otherwise the Reader will be scheduled as FIRST algorithm,
// most importantly BEFORE any of the wrapped Marlin processors to which
// this converter is attached.
// - The empty Frame we introduce into the TES here does not interfere with
// the Writer for EDM4hep output (which is always scheduled last), as that
// will simply get this Frame instead of creating an empty one itself
// - There are no scheduling issues / race conditions, since the
// MarlinProcessorWrapper algorithm is not re-entrant and can thus not be
// run in parallel
debug() << "Could not retrieve Frame from expected location. Registering a new empty Frame into the TES" << endmsg;
auto tmp = new AnyDataWrapper<podio::Frame>(podio::Frame());
if (m_eventDataSvc->registerObject("/Event" + k4FWCore::frameLocation, tmp).isFailure()) {
error() << "Could not retrieve Frame from expected location in TES and could not register a new one" << endmsg;
throw std::runtime_error("Could not get EDM4hep event (Frame) for conversions");
}
return tmp->getData();
}

// Parse property parameters and convert the indicated collections.
// Use the collection names in the parameters to read and write them
StatusCode EDM4hep2LcioTool::convertCollections(lcio::LCEventImpl* lcio_event) {
std::optional<std::reference_wrapper<const podio::Frame>> edmEvent;
const auto& edmEvent = getEDM4hepEvent();
// use m_collsToConvert to detect whether we run the first time and cache the
// results as we can assume that all the events have the same contents
if (m_collsToConvert.empty()) {
Expand All @@ -408,8 +443,7 @@ StatusCode EDM4hep2LcioTool::convertCollections(lcio::LCEventImpl* lcio_event) {
info() << "Converting all collections from EDM4hep to LCIO" << endmsg;
if (m_podioDataSvc) {
// If we have the PodioDataSvc get the collections available from frame
edmEvent = m_podioDataSvc->getEventFrame();
for (const auto& name : edmEvent.value().get().getAvailableCollections()) {
for (const auto& name : edmEvent.getAvailableCollections()) {
const auto& [_, inserted] = collNameMapping.emplace(name, name);
debug() << fmt::format("Adding '{}' from Frame to conversion? {}", name, inserted) << endmsg;
}
Expand Down Expand Up @@ -453,19 +487,9 @@ StatusCode EDM4hep2LcioTool::convertCollections(lcio::LCEventImpl* lcio_event) {
debug() << "Event: " << lcio_event->getEventNumber() << " Run: " << lcio_event->getRunNumber() << endmsg;

EDM4hep2LCIOConv::sortParticleIDs(pidCollections);
if (!m_podioDataSvc) {
DataObject* p;
StatusCode code = m_eventDataSvc->retrieveObject("/Event" + k4FWCore::frameLocation, p);
if (code.isSuccess()) {
auto* frame = dynamic_cast<AnyDataWrapper<podio::Frame>*>(p);
edmEvent = std::cref(frame->getData());
} else {
auto frame = podio::Frame{};
edmEvent = frame;
}
}

for (const auto& pidCollMeta : pidCollections) {
auto algoId = attachParticleIDMetaData(lcio_event, edmEvent.value(), pidCollMeta);
auto algoId = attachParticleIDMetaData(lcio_event, edmEvent, pidCollMeta);
if (!algoId.has_value()) {
// Now go over the collections that have been produced in a functional algorithm (if any)
bool found = false;
Expand Down