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.

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

docs: Document Track EDM #2797

Merged
merged 10 commits into from
Feb 14, 2024
Merged

Conversation

@paulgessinger
Copy link
Member Author

@andiwand

@paulgessinger paulgessinger added this to the next milestone Dec 11, 2023
@github-actions github-actions bot added Component - Core Affects the Core module Infrastructure Changes to build tools, continous integration, ... Component - Plugins Affects one or more Plugins Component - Documentation Affects the documentation Vertexing labels Dec 11, 2023
@paulgessinger paulgessinger linked an issue Dec 11, 2023 that may be closed by this pull request
andiwand
andiwand previously approved these changes Dec 11, 2023
Copy link

codecov bot commented Dec 11, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (19464fa) 48.84% compared to head (92bce34) 48.84%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2797   +/-   ##
=======================================
  Coverage   48.84%   48.84%           
=======================================
  Files         495      495           
  Lines       28909    28909           
  Branches    13732    13732           
=======================================
  Hits        14122    14122           
  Misses       4890     4890           
  Partials     9897     9897           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@paulgessinger paulgessinger added the 🛑 blocked This item is blocked by another item label Dec 12, 2023
@github-actions github-actions bot added Component - Examples Affects the Examples module Track Finding labels Dec 12, 2023
kodiakhq bot pushed a commit that referenced this pull request Dec 18, 2023
This is pulled out of #2797 and includes only the doxygen comment changes.

Blocked by:
- #2712
- #2817 
- #2807
commit 9cc6174
Merge: acf3c1b ba0ab93
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 18 19:10:14 2023 +0100

    Merge remote-tracking branch 'origin/main' into doc/track-edm

    # Conflicts:
    #	Core/include/Acts/EventData/MultiTrajectory.hpp
    #	Core/include/Acts/EventData/MultiTrajectoryBackendConcept.hpp
    #	Core/include/Acts/EventData/TrackContainer.hpp
    #	Core/include/Acts/EventData/TrackContainerBackendConcept.hpp
    #	Core/include/Acts/EventData/TrackProxy.hpp
    #	Core/include/Acts/EventData/TrackStateProxy.hpp
    #	Core/include/Acts/EventData/VectorMultiTrajectory.hpp
    #	Core/include/Acts/EventData/VectorTrackContainer.hpp
    #	Plugins/Podio/include/Acts/Plugins/Podio/PodioTrackContainer.hpp
    #	Plugins/Podio/include/Acts/Plugins/Podio/PodioTrackStateContainer.hpp
    #	docs/core/eventdata/index.md
    #	docs/core/eventdata/measurements.md
    #	docs/core/eventdata/particle_hypothesis.md
    #	docs/core/eventdata/tracks.md
    #	docs/requirements.txt

commit acf3c1b
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Dec 13 08:21:34 2023 +0100

    sections

commit 2bd5ee9
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 22:44:01 2023 +0100

    using namespace

commit ef5f417
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 22:28:12 2023 +0100

    describe proxy accessors

commit a27b470
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 21:59:17 2023 +0100

    fix doxygen error

commit 29d0954
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 19:16:02 2023 +0100

    wip: write about accessors

commit 5efe30f
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 19:15:29 2023 +0100

    feat: Generalize Accessors for Tracks and TrackStates

    Uses the same underlying pattern but now works for both tracks and
    trackstates

commit 1a7f560
Merge: 88806fe 8c0b283
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 17:37:42 2023 +0100

    Merge branch 'feat/track-edm-make-object' into doc/track-edm

commit 88806fe
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 17:28:28 2023 +0100

    remove the make functions in favor of acts-project#2817

commit 8c0b283
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 17:11:54 2023 +0100

    feat: Track EDM: Add functions to create and return proxies

commit c89e7ce
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 17:02:33 2023 +0100

    some reshuffling in MTJ

commit b2d2b4e
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 17:02:22 2023 +0100

    compile fix

commit ebc9779
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 16:51:33 2023 +0100

    add makeTrackState function to MTJ

commit 27cc858
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 16:36:52 2023 +0100

    comment fixes to multitrajectory

commit 7be6aa1
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 15:13:00 2023 +0100

    progress

commit 3f799d1
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 14:09:19 2023 +0100

    fixes

commit db90029
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 09:21:08 2023 +0100

    track proxy comments sort of done

commit cc33f7c
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 11 17:30:55 2023 +0100

    fix bad merge (particleHypothesis got reverted)

commit 4126080
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 11 15:19:46 2023 +0100

    tmp

commit 3634e24
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 11 11:25:01 2023 +0100

    don't automatically run white paper index

commit 66869d7
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 11 10:46:34 2023 +0100

    split up event data into folder with sub files

commit 56ca27b
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Tue Dec 12 15:46:39 2023 +0100

    format fix

commit c1b54da
Author: Paul Gessinger <paul.gessinger@cern.ch>
Date:   Tue Dec 12 14:21:14 2023 +0100

    fix aliasing error

commit b5da69a
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 11 17:23:33 2023 +0100

    refactor!: Split TrackStateProxy into own header, public

    This moves TrackStateProxy into it's own header file, and moves it out
    of the `detail_lt` namespace.

commit bb039f9
Merge: 620da1d f7106bc
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 11 15:23:52 2023 +0100

    Merge remote-tracking branch 'origin/main' into refactor/track-edm-copy-dynamic-backends

commit 620da1d
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 4 17:03:24 2023 +0100

    fix another concept violation

commit c9df58e
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Mon Dec 4 16:37:42 2023 +0100

    fix concepts

commit 3e024c1
Merge: e6b50de cf14470
Author: Paul Gessinger <paul.gessinger@cern.ch>
Date:   Wed Nov 29 18:54:01 2023 +0100

    Merge branch 'main' into refactor/track-edm-copy-dynamic-backends

commit e6b50de
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 29 18:43:08 2023 +0100

    Revert "centralize dynamic columns recovery and use typelist"

    This reverts commit 6dcf392.

commit 4ddf5c3
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 29 18:41:35 2023 +0100

    Revert "build: Add target to build all unit tests"

    This reverts commit 4bbe4af.

commit 6dcf392
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 29 18:40:26 2023 +0100

    centralize dynamic columns recovery and use typelist

commit edfa27f
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 29 18:20:19 2023 +0100

    dynamic column test implementation working

    Added construction from mutable to const track state container (albeit fragile)

commit 0a7506f
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 29 17:18:53 2023 +0100

    fix track container test

commit 4bbe4af
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 29 17:17:32 2023 +0100

    build: Add target to build all unit tests

commit 32d9918
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 29 16:58:06 2023 +0100

    complete actual copy implementation

commit a694752
Merge: 0bcaf7f 1bf0daf
Author: Paul Gessinger <paul.gessinger@cern.ch>
Date:   Wed Nov 29 16:02:57 2023 +0100

    Merge branch 'main' into refactor/track-edm-copy-dynamic-backends

commit 0bcaf7f
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 22 14:36:41 2023 +0100

    missing include

commit e5dd9fb
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 22 14:31:40 2023 +0100

    Add particle hypo support in PODIO backend

commit bfb8f41
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 22 14:11:14 2023 +0100

    update PODIO track backend to be complete and current (missing particle
    hypothesis still)

commit 8956d6c
Author: Paul Gessinger <hello@paulgessinger.com>
Date:   Wed Nov 22 11:26:28 2023 +0100

    feat: Dyn col copying btw. different backend (Track+TrackState)
@github-actions github-actions bot removed Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Event Data Model Track Finding labels Dec 18, 2023
@paulgessinger paulgessinger marked this pull request as ready for review December 18, 2023 19:29
Copy link
Contributor

@andiwand andiwand left a comment

Choose a reason for hiding this comment

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

1/2

docs/glossary.md Outdated Show resolved Hide resolved
docs/glossary.md Outdated Show resolved Hide resolved
docs/glossary.md Outdated Show resolved Hide resolved
docs/core/eventdata/index.md Show resolved Hide resolved
docs/core/eventdata/index.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added Component - Core Affects the Core module Event Data Model labels Feb 13, 2024
Copy link
Contributor

@andiwand andiwand left a comment

Choose a reason for hiding this comment

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

2/2

docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
docs/core/eventdata/tracks.md Outdated Show resolved Hide resolved
@andiwand
Copy link
Contributor

Thank you @paulgessinger, I think this is excellent!

@paulgessinger
Copy link
Member Author

@AJPfleger can you have another look?

AJPfleger
AJPfleger previously approved these changes Feb 14, 2024
@github-actions github-actions bot added the Component - Plugins Affects one or more Plugins label Feb 14, 2024
@kodiakhq kodiakhq bot merged commit d043298 into acts-project:main Feb 14, 2024
54 checks passed
@tboldagh
Copy link
Contributor

@paulgessinger I am late to this game it seems (sorry buffer overflow). I just wonder if we could point from the docu to Athena repo. It is public for something.

@paulgessinger
Copy link
Member Author

@tboldagh Absolutely. Where do you want it to point to? I can make the change, or feel free to submit a PR updating the documentation with the link.

@paulgessinger paulgessinger deleted the doc/track-edm branch February 15, 2024 14:12
@paulgessinger paulgessinger modified the milestones: next, v33.0.0 Mar 6, 2024
kodiakhq bot pushed a commit that referenced this pull request Mar 28, 2024
EleniXoch pushed a commit to EleniXoch/acts that referenced this pull request May 6, 2024
EleniXoch pushed a commit to EleniXoch/acts that referenced this pull request May 6, 2024
asalzburger pushed a commit to asalzburger/acts that referenced this pull request May 21, 2024
asalzburger pushed a commit to asalzburger/acts that referenced this pull request May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Core Affects the Core module Component - Documentation Affects the documentation Component - Plugins Affects one or more Plugins Event Data Model Infrastructure Changes to build tools, continous integration, ...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write documentation on the Track EDM
5 participants