Skip to content
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

Make it possible to transparently migrate to TrackerHit interface #174

Merged
merged 5 commits into from
Feb 22, 2024
Merged

Make it possible to transparently migrate to TrackerHit interface #174

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a9eefa
Rename TrackerHit to TrackerHit3D for the concrete type
tmadlener Nov 27, 2023
1402de9
Make transition transparent
tmadlener Feb 5, 2024
9de9e48
Fix runtime issue
tmadlener Feb 5, 2024
3d81265
Remove unnecessary includes
tmadlener Feb 22, 2024
95ad584
Remove slightly misleading warning
tmadlener Feb 22, 2024
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
14 changes: 13 additions & 1 deletion k4FWCore/components/PodioInput.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,14 @@
#include "edm4hep/SimTrackerHitCollection.h"
#include "edm4hep/TimeSeriesCollection.h"
#include "edm4hep/TrackCollection.h"
#if __has_include("edm4hep/TrackerHit3DCollection.h")
#include "edm4hep/TrackerHit3DCollection.h"
#else
#include "edm4hep/TrackerHitCollection.h"
namespace edm4hep {
using TrackerHit3DCollection = edm4hep::TrackerHitCollection;
} // namespace edm4hep
#endif
#include "edm4hep/TrackerHitPlaneCollection.h"
#include "edm4hep/TrackerPulseCollection.h"
#include "edm4hep/VertexCollection.h"
Expand Down Expand Up @@ -85,8 +92,13 @@ void PodioInput::fillReaders() {
m_readers["edm4hep::ClusterCollection"] = [&](std::string_view collName) {
maybeRead<edm4hep::ClusterCollection>(collName);
};
m_readers["edm4hep::TrackerHit3DCollection"] = [&](std::string_view collName) {
maybeRead<edm4hep::TrackerHit3DCollection>(collName);
};
m_readers["edm4hep::TrackerHitCollection"] = [&](std::string_view collName) {
maybeRead<edm4hep::TrackerHitCollection>(collName);
warning() << "Reading a TrackerHitCollection via TrackerHit3DCollection (" << collName
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure about this warning; the only way you can reach here is when TrackerHitCollection is available (otherwise the type will never be edm4hep::TrackerHitCollection) in which case TrackerHit3DCollection is an alias to TrackerHitCollection meaning this warning wouldn't be true, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It will be possible to come here from old files, I think. In that case the old name will still be in the file metadata and propagate until here. However, we are fine just reading that through the new type. The warning might not be necessary though, as it will probably do the right thing. Additionally, all the other changes that we are currently introducing will break existing files in any case.

Copy link
Member

Choose a reason for hiding this comment

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

How are old files going to be readable? I'm quite sure they are not. ROOT finds something called "TrackerHitCollection" that it doesn't know anything about and it's impossible for it to reconstruct a "Tracker3DHitCollection". So this is why I think this warning can't be triggered because if the collections are saved as TrackerHitCollection then they can't be read

<< "). Make sure to transition properly" << endmsg;
tmadlener marked this conversation as resolved.
Show resolved Hide resolved
maybeRead<edm4hep::TrackerHit3DCollection>(collName);
};
m_readers["edm4hep::TrackerHitPlaneCollection"] = [&](std::string_view collName) {
maybeRead<edm4hep::TrackerHitPlaneCollection>(collName);
Expand Down
9 changes: 8 additions & 1 deletion test/k4FWCoreTest/src/components/ExampleFunctionalConsumerMultiple.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,14 @@
#include "edm4hep/MCParticleCollection.h"
#include "edm4hep/SimTrackerHitCollection.h"
#include "edm4hep/TrackCollection.h"
#if __has_include("edm4hep/TrackerHit3DCollection.h")
#include "edm4hep/TrackerHit3DCollection.h"
#else
#include "edm4hep/TrackerHitCollection.h"
namespace edm4hep {
using TrackerHit3DCollection = edm4hep::TrackerHitCollection;
} // namespace edm4hep
#endif
#include "podio/UserDataCollection.h"

// Define BaseClass_t
Expand All @@ -37,7 +44,7 @@
using FloatColl = podio::UserDataCollection<float>;
using ParticleColl = edm4hep::MCParticleCollection;
using SimTrackerHitColl = edm4hep::SimTrackerHitCollection;
using TrackerHitColl = edm4hep::TrackerHitCollection;
using TrackerHitColl = edm4hep::TrackerHit3DCollection;
using TrackColl = edm4hep::TrackCollection;

struct ExampleFunctionalConsumerMultiple final
Expand Down
11 changes: 9 additions & 2 deletions test/k4FWCoreTest/src/components/ExampleFunctionalProducerMultiple.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,14 @@
#include "edm4hep/MCParticleCollection.h"
#include "edm4hep/SimTrackerHitCollection.h"
#include "edm4hep/TrackCollection.h"
#if __has_include("edm4hep/TrackerHit3DCollection.h")
#include "edm4hep/TrackerHit3DCollection.h"
#else
#include "edm4hep/TrackerHitCollection.h"
namespace edm4hep {
using TrackerHit3DCollection = edm4hep::TrackerHitCollection;
} // namespace edm4hep
#endif
#include "podio/UserDataCollection.h"

#include <string>
Expand All @@ -33,7 +40,7 @@
using Float = podio::UserDataCollection<float>;
using Particle = edm4hep::MCParticleCollection;
using SimTrackerHit = edm4hep::SimTrackerHitCollection;
using TrackerHit = edm4hep::TrackerHitCollection;
using TrackerHit = edm4hep::TrackerHit3DCollection;
using Track = edm4hep::TrackCollection;

struct ExampleFunctionalProducerMultiple final
Expand Down Expand Up @@ -71,7 +78,7 @@ struct ExampleFunctionalProducerMultiple final
auto hit = simTrackerHits.create();
hit.setPosition({3, 4, 5});

auto trackerHits = edm4hep::TrackerHitCollection();
auto trackerHits = edm4hep::TrackerHit3DCollection();
auto trackerHit = trackerHits.create();
trackerHit.setPosition({3, 4, 5});

Expand Down
10 changes: 9 additions & 1 deletion test/k4FWCoreTest/src/components/ExampleFunctionalTransformerMultiple.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,15 @@
#include "edm4hep/MCParticleCollection.h"
#include "edm4hep/SimTrackerHitCollection.h"
#include "edm4hep/TrackCollection.h"
#if __has_include("edm4hep/TrackerHit3DCollection.h")
#include "edm4hep/TrackerHit3DCollection.h"
#else
#include "edm4hep/TrackerHitCollection.h"
namespace edm4hep {
using TrackerHit3DCollection = edm4hep::TrackerHitCollection;
} // namespace edm4hep
#endif
#include "edm4hep/TrackerHit3DCollection.h"
#include "podio/UserDataCollection.h"

// Define BaseClass_t
Expand All @@ -35,7 +43,7 @@
using FloatColl = podio::UserDataCollection<float>;
using ParticleColl = edm4hep::MCParticleCollection;
using SimTrackerHitColl = edm4hep::SimTrackerHitCollection;
using TrackerHitColl = edm4hep::TrackerHitCollection;
using TrackerHitColl = edm4hep::TrackerHit3DCollection;
using TrackColl = edm4hep::TrackCollection;

// As a simple example, we'll write an integer and a collection of MCParticles
Expand Down
8 changes: 8 additions & 0 deletions test/k4FWCoreTest/src/components/k4FWCoreTest_CheckExampleEventData.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,15 @@
#include "edm4hep/MCParticleCollection.h"
#include "edm4hep/SimTrackerHitCollection.h"
#include "edm4hep/TrackCollection.h"
#if __has_include("edm4hep/TrackerHit3DCollection.h")
#include "edm4hep/TrackerHit3DCollection.h"
#else
#include "edm4hep/TrackerHitCollection.h"
namespace edm4hep {
using TrackerHit3DCollection = edm4hep::TrackerHitCollection;
} // namespace edm4hep
#endif
#include "edm4hep/TrackerHitPlaneCollection.h"

DECLARE_COMPONENT(k4FWCoreTest_CheckExampleEventData)

Expand Down
4 changes: 0 additions & 4 deletions test/k4FWCoreTest/src/components/k4FWCoreTest_CheckExampleEventData.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@
// datamodel
namespace edm4hep {
class MCParticleCollection;
class SimTrackerHitCollection;
class TrackerHitCollection;
class SimCaloHitCollection;
class TrackCollection;
} // namespace edm4hep

class k4FWCoreTest_CheckExampleEventData : public GaudiAlgorithm {
Expand Down
5 changes: 2 additions & 3 deletions test/k4FWCoreTest/src/components/k4FWCoreTest_CreateExampleEventData.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
#include "edm4hep/MCParticleCollection.h"
#include "edm4hep/SimTrackerHitCollection.h"
#include "edm4hep/TrackCollection.h"
#include "edm4hep/TrackerHitCollection.h"
#if __has_include("edm4hep/EDM4hepVersion.h")
#include "edm4hep/EDM4hepVersion.h"
#else
Expand Down Expand Up @@ -74,8 +73,8 @@ StatusCode k4FWCoreTest_CreateExampleEventData::execute() {
auto hit = simTrackerHits->create();
hit.setPosition({3, 4, 5});

edm4hep::TrackerHitCollection* trackerHits = m_TrackerHitHandle.createAndPut();
auto trackerHit = trackerHits->create();
edm4hep::TrackerHit3DCollection* trackerHits = m_TrackerHitHandle.createAndPut();
auto trackerHit = trackerHits->create();
trackerHit.setPosition({3, 4, 5});

edm4hep::TrackCollection* tracks = m_trackHandle.createAndPut();
Expand Down
13 changes: 11 additions & 2 deletions test/k4FWCoreTest/src/components/k4FWCoreTest_CreateExampleEventData.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,23 @@
// key4hep
#include "k4FWCore/DataHandle.h"

// edm4hep
#if __has_include("edm4hep/TrackerHit3DCollection.h")
#include "edm4hep/TrackerHit3DCollection.h"
#else
#include "edm4hep/TrackerHitCollection.h"
namespace edm4hep {
using TrackerHit3DCollection = edm4hep::TrackerHitCollection;
} // namespace edm4hep
#endif

// podio
#include "podio/UserDataCollection.h"

// datamodel
namespace edm4hep {
class MCParticleCollection;
class SimTrackerHitCollection;
class TrackerHitCollection;
class SimCaloHitCollection;
class TrackCollection;
} // namespace edm4hep
Expand Down Expand Up @@ -69,7 +78,7 @@ class k4FWCoreTest_CreateExampleEventData : public GaudiAlgorithm {
DataHandle<edm4hep::MCParticleCollection> m_mcParticleHandle{"MCParticles", Gaudi::DataHandle::Writer, this};
/// Handle for the SimTrackerHits to be written
DataHandle<edm4hep::SimTrackerHitCollection> m_simTrackerHitHandle{"SimTrackerHits", Gaudi::DataHandle::Writer, this};
DataHandle<edm4hep::TrackerHitCollection> m_TrackerHitHandle{"TrackerHits", Gaudi::DataHandle::Writer, this};
DataHandle<edm4hep::TrackerHit3DCollection> m_TrackerHitHandle{"TrackerHits", Gaudi::DataHandle::Writer, this};

/// Handle for the Tracks to be written
DataHandle<edm4hep::TrackCollection> m_trackHandle{"Tracks", Gaudi::DataHandle::Writer, this};
Expand Down
Loading