feat: cloner algorithm and factory by wdconinc · Pull Request #2384 · eic/EICrecon

wdconinc · 2026-01-31T22:26:01Z

Briefly, what does this PR introduce?

This PR introduces a cloning meta algorithm and factory to turn subset collections into collections of objects. This is used here, in particular, to create a clone of the MCBeamElectrons and MCBeamProtons collections (subset collections to MCParticles), so those can be stored in a digitization step in #2380 without storing all truth of MCParticles.

What kind of change does this PR introduce?

Bug fix (issue #__)
New feature (issue: cloner meta algorithm)
Documentation update
Other: __

Please check if this PR fulfills the following:

Tests for the changes have been added
Documentation has been added / updated
Changes have been communicated to collaborators

Does this PR introduce breaking changes? What changes might users need to make to their code?

No.

Does this PR change default behavior?

No.

Copilot

Pull request overview

This PR adds a small “cloner” meta-algorithm and factory, and wires it into the beam plugin to materialize standalone copies of selected MC beam subset collections, enabling two-stage digitization workflows that don’t keep the full MCParticles truth.

Changes:

Introduces Cloner<T> meta algorithm to duplicate elements from an input collection into a new output collection.
Adds Cloner_factory<T> JANA omni-factory wrapper around Cloner<T>.
Updates src/global/beam/beam.cc to produce MCBeamElectronsCloned and MCBeamProtonsCloned collections from the existing beam subset collections.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
src/global/beam/beam.cc	Registers two `Cloner_factory<edm4hep::MCParticle>` instances to clone `MCBeamElectrons` and `MCBeamProtons` into standalone collections for two-stage workflows.
src/factories/meta/Cloner_factory.h	Defines a generic JOmni-based factory that wires a single input PODIO collection into the `Cloner<T>` algorithm and exposes a single cloned output collection.
src/algorithms/meta/Cloner.h	Implements the generic `Cloner<T>` algorithm that iterates an input collection and pushes `obj.clone()` into the output collection to break subset dependencies.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

github-actions · 2026-02-01T00:09:11Z

Capybara summary for PR 2384

Last updated 2026-07-21T18:49-04:00 2e4faf3

This PR applies the include-what-you-use fixes as suggested by https://github.com/eic/EICrecon/actions/runs/21552375295. Please merge this PR into the branch `cloner` to resolve failures in PR #2384. Auto-generated by [create-pull-request][1] [1]: https://github.com/peter-evans/create-pull-request Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

wdconinc · 2026-02-01T16:57:34Z

No diffs.

simonge · 2026-02-01T21:27:34Z

Commenting a bit of a longer conceptual view, rather than directly this purge of MC information (Thinking about #2385 and #2384). Should we be looking at storing the beam particles as Reconstructed Particles? Even after the metadata is available.

An algorithm would then take the vertex collection and the metadata on the beam settings to reconstruct a particle with an accurate covariance matrix. Which would be essential for the qError suggestion in eic/EDM4eic#93

wdconinc · 2026-02-01T21:47:14Z

Commenting a bit of a longer conceptual view, rather than directly this purge of MC information (Thinking about #2385 and #2384). Should we be looking at storing the beam particles as Reconstructed Particles? Even after the metadata is available.

An algorithm would then take the vertex collection and the metadata on the beam settings to reconstruct a particle with an accurate covariance matrix. Which would be essential for the qError suggestion in eic/EDM4eic#93

I think ultimately there will need to be some way of combining the metadata with primary vertex to get t0 and such, so that seems like a reasonable way forward. But I don't know how close we are to even starting that.

This PR applies the include-what-you-use fixes as suggested by https://github.com/eic/EICrecon/actions/runs/21552375295. Please merge this PR into the branch `cloner` to resolve failures in PR #2384. Auto-generated by [create-pull-request][1] [1]: https://github.com/peter-evans/create-pull-request Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

This PR applies the include-what-you-use fixes as suggested by https://github.com/eic/EICrecon/actions/runs/21552375295. Please merge this PR into the branch `cloner` to resolve failures in PR #2384. Auto-generated by [create-pull-request][1] [1]: https://github.com/peter-evans/create-pull-request Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

+ * This algorithm takes an input collection and creates an output collection
+ * containing cloned copies of those elements. This is primarily useful for
+ * subset collections (where elements point to objects in another collection)
+ * to create standalone collections that can be stored without the original.
+ *


+  // Clone MCBeamElectrons and MCBeamProtons for two-stage workflows
+  // This allows storing just the beam particles without the full MCParticles collection
+  app->Add(new JOmniFactoryGeneratorT<Cloner_factory<edm4hep::MCParticle>>(
+      "MCBeamElectronsCloned", {"MCBeamElectrons"}, {"MCBeamElectronsCloned"}, app));
+  app->Add(new JOmniFactoryGeneratorT<Cloner_factory<edm4hep::MCParticle>>(


veprbl · 2026-07-21T21:32:59Z

+  // Clone MCBeamElectrons and MCBeamProtons for two-stage workflows
+  // This allows storing just the beam particles without the full MCParticles collection
+  app->Add(new JOmniFactoryGeneratorT<Cloner_factory<edm4hep::MCParticle>>(
+      "MCBeamElectronsCloned", {"MCBeamElectrons"}, {"MCBeamElectronsCloned"}, app));


Should we come up with naming scheme for subset collections instead? How about MCBeamElectronsSubset?

Do we care about the breakage that could introduce?

As far as I can imagine, no one knows how to work with subset collections without PODIO.

Ok, I'll append subset later

This PR applies the include-what-you-use fixes as suggested by https://github.com/eic/EICrecon/actions/runs/29870108483. Please merge this PR into the branch `cloner` to resolve failures in PR #2384. Auto-generated by [create-pull-request][1] [1]: https://github.com/peter-evans/create-pull-request Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

src/algorithms/meta/Cloner.h:43

obj.clone() copies the object's relations as well. For relation-heavy types like edm4hep::MCParticle this means the cloned objects can still reference the original MCParticles collection (e.g. via parent/daughter relations), defeating the stated goal of being able to persist the cloned collection without persisting the original and likely triggering dangling-relation checks. The codebase explicitly avoids clone() for MCParticles for this reason (see src/algorithms/reco/UndoAfterBurner.cc where relationships are not cloned). Consider either (a) implementing an MCParticle-specific cloning path that copies only the value fields and clears/omits relations, or (b) extending this algorithm with an option to drop/rewire relations so outputs are self-contained when the source collection is not written.

    // Clone each element from input to output
    for (const auto& obj : *in_coll) {
      out_coll->push_back(obj.clone());
    }

Copilot AI review requested due to automatic review settings January 31, 2026 22:26

Copilot started reviewing on behalf of wdconinc January 31, 2026 22:26 View session

Copilot AI reviewed Jan 31, 2026

View reviewed changes

Comment thread src/factories/meta/Cloner_factory.h

Copilot AI review requested due to automatic review settings January 31, 2026 23:02

Copilot started reviewing on behalf of wdconinc January 31, 2026 23:03 View session

This comment was marked as resolved.

Sign in to view

epic-capybara mentioned this pull request Jan 31, 2026

feat: cloner algorithm and factory (fix: iwyu) #2389

Merged

wdconinc temporarily deployed to github-pages February 1, 2026 00:07 — with GitHub Actions Inactive

wdconinc enabled auto-merge February 1, 2026 03:59

Copilot AI review requested due to automatic review settings February 1, 2026 04:02

Copilot started reviewing on behalf of wdconinc February 1, 2026 04:03 View session

This comment was marked as resolved.

Sign in to view

wdconinc temporarily deployed to github-pages February 1, 2026 05:11 — with GitHub Actions Inactive

wdconinc requested review from a team and rahmans1 and removed request for a team February 1, 2026 16:58

wdconinc force-pushed the cloner branch from 182c146 to 63d3441 Compare February 14, 2026 03:46

wdconinc had a problem deploying to github-pages February 14, 2026 07:50 — with GitHub Actions Failure

Copilot AI review requested due to automatic review settings February 15, 2026 18:41

wdconinc force-pushed the cloner branch from 63d3441 to 1f00697 Compare February 15, 2026 18:41

Copilot started reviewing on behalf of wdconinc February 15, 2026 18:42 View session

Copilot AI reviewed Feb 15, 2026

View reviewed changes

Comment thread src/algorithms/meta/Cloner.h

Comment thread src/factories/meta/Cloner_factory.h

wdconinc temporarily deployed to github-pages February 15, 2026 19:30 — with GitHub Actions Inactive

wdconinc and others added 5 commits July 21, 2026 16:28

feat: cloner algorithm and factory

557d628

feat: create MCBeamElectronsCloned and MCBeamProtonsCloned

309274d

fix: rm ChangeRun

c85ac0c

fix: Cloner_factory::Configure

ce67ed8

Copilot AI review requested due to automatic review settings July 21, 2026 21:28

wdconinc force-pushed the cloner branch from 1f00697 to ce67ed8 Compare July 21, 2026 21:28

Copilot started reviewing on behalf of wdconinc July 21, 2026 21:29 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

veprbl reviewed Jul 21, 2026

View reviewed changes

epic-capybara mentioned this pull request Jul 21, 2026

feat: cloner algorithm and factory (fix: iwyu) #2764

Merged

Copilot AI review requested due to automatic review settings July 21, 2026 21:38

Copilot started reviewing on behalf of veprbl July 21, 2026 21:39 View session

Copilot AI reviewed Jul 21, 2026

View reviewed changes

veprbl temporarily deployed to github-pages July 21, 2026 22:49 — with GitHub Actions Inactive

Uh oh!

Conversation

wdconinc commented Jan 31, 2026

Briefly, what does this PR introduce?

What kind of change does this PR introduce?

Please check if this PR fulfills the following:

Does this PR introduce breaking changes? What changes might users need to make to their code?

Does this PR change default behavior?

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

github-actions Bot commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Capybara summary for PR 2384

Uh oh!

This comment was marked as resolved.

Uh oh!

wdconinc commented Feb 1, 2026

Uh oh!

simonge commented Feb 1, 2026

Uh oh!

wdconinc commented Feb 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

veprbl Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

wdconinc Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

veprbl Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

wdconinc Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented Feb 1, 2026 •

edited

Loading