output true track parameters from particle generator
replace ParticleSmearing with TrackParameterSmearing which can be applied in a wider range

Oct 25 '24 14:10 andiwand

📊: Physics performance monitoring for 4f5daa0fbe5e1fe8a0aefa2e998455bc6db118cf

physmon summary

Oct 25 '24 15:10 github-actions[bot]

I think smearing track parameters is more general than smearing particles to tracks. I enabled the generator to distribute true track parameters which can also be used for other stuff than smearing. I saw a couple of times that we disable the smearing with 0 sigmas which can now be purely handled by the generator.

Nov 02 '24 07:11 andiwand

Actually to make this work correctly I have to extract the track parameters from particles in a different spot. Right now the track parameters and truth proto tracks do not reliably align anymore. To solve it it makes more sense to have a separate extraction algorithm I believe.

Nov 02 '24 07:11 andiwand

## Walkthrough
Focus on the changes, we must. Renaming and restructuring parameters related to particle tracking configurations, these changes do. The `ParticleSmearingSigmas` class, now `TrackSmearingSigmas`, renamed it is. Parameters updated, they are, from `d0`, `d0PtA`, and others, to `loc0`, `loc0PtA`, and more. New classes for extracting and smearing track parameters introduced, while the `ParticleSmearing` class removed it is. Clarity and consistency in the codebase enhanced, yes.

## Changes

| File | Change Summary |
|------|----------------|
| `CI/physmon/workflows/physmon_trackfinding_1muon.py` | Renamed `ParticleSmearingSigmas` to `TrackSmearingSigmas` and updated parameters from `d0`, `d0PtA`, etc., to `loc0`, `loc0PtA`, etc. |
| `Examples/Algorithms/Generators/ActsExamples/Generators/EventGenerator.cpp` | Removed namespace prefix `ActsExamples::` from class and method signatures, updated include directives. |
| `Examples/Algorithms/Generators/ActsExamples/Generators/EventGenerator.hpp` | Removed unused header `<functional>`, updated comment for `outputVertices` in `Config` struct. |
| `Examples/Algorithms/TruthTracking/ActsExamples/TruthTracking/ParticleSmearing.cpp` | Deleted file, removed `ParticleSmearing` class and its methods. |
| `Examples/Algorithms/TruthTracking/ActsExamples/TruthTracking/ParticleTrackParamExtractor.cpp` | Added `ParticleTrackParamExtractor` class with methods for extracting track parameters. |
| `Examples/Algorithms/TruthTracking/ActsExamples/TruthTracking/ParticleTrackParamExtractor.hpp` | Introduced `ParticleTrackParamExtractor` class and `Config` struct for track parameter extraction. |
| `Examples/Algorithms/TruthTracking/ActsExamples/TruthTracking/TrackParameterSmearing.cpp` | Added `TrackParameterSmearing` class for smearing track parameters based on configuration. |
| `Examples/Algorithms/TruthTracking/ActsExamples/TruthTracking/TrackParameterSmearing.hpp` | Renamed class from `ParticleSmearing` to `TrackParameterSmearing`, updated `Config` struct parameters. |
| `Examples/Algorithms/TruthTracking/CMakeLists.txt` | Removed `ParticleSmearing.cpp`, added `ParticleTrackParamExtractor.cpp` and `TrackParameterSmearing.cpp`. |
| `Examples/Python/python/acts/examples/reconstruction.py` | Replaced `ParticleSmearingSigmas` with `TrackSmearingSigmas`, updated function signatures. |
| `Examples/Python/src/Generators.cpp` | Added multiple generator classes and refined generator exposure to Python. |
| `Examples/Python/src/TruthTracking.cpp` | Replaced `ParticleSmearing` with `ParticleTrackParamExtractor`, updated parameters. |
| `Examples/Python/tests/conftest.py` | Updated `basic_prop_seq` fixture to use `ParticleTrackParamExtractor`, modified logging levels. |
| `Examples/Python/tests/test_algorithms.py` | Renamed module from `ParticleSmearing` to `TrackParameterSmearing`. |
| `Examples/Python/tests/test_propagation.py` | Updated tests to replace particle smearing with track parameter extraction. |
| `Examples/Scripts/Optimization/ckf.py` | Renamed `ParticleSmearingSigmas` to `TrackSmearingSigmas`, updated parameters. |
| `Examples/Scripts/Python/ckf_tracks.py` | Renamed `ParticleSmearingSigmas` to `TrackSmearingSigmas`, updated parameters. |
| `Examples/Scripts/Python/material_validation.py` | Replaced `ParticleSmearing` with `ParticleTrackParamExtractor`, updated parameters. |
| `Examples/Scripts/Python/material_validation_itk.py` | Added parameters for dynamic configuration, updated extractor instantiation. |
| `Examples/Scripts/Python/propagation.py` | Replaced `ParticleSmearing` with `ParticleTrackParamExtractor`, updated parameters. |
| `Examples/Scripts/Python/vertex_fitting.py` | Updated to use `TrackParameterSmearing` and `ParticleTrackParamExtractor`. |
| `Examples/Scripts/Python/full_chain_test.py` | Updated argument parsing and handling of particle tracking and reconstruction. |

## Possibly related PRs
- **#3836**: Changes related to renaming `ParticleSmearingSigmas` to `TrackSmearingSigmas` are connected to modifications in the `HitSelector` class, enhancing the tracking process.
- **#3886**: This PR modifies the `RootTrackSummaryWriter` to function without truth information, which aligns with the broader context of handling track parameters and configurations in the main PR.

## Suggested labels
`automerge`

> "In code we trust, with names anew,  
> Track smearing sigmas, clear and true.  
> From particles to tracks, we now align,  
> With parameters refined, our paths entwine.  
> New classes emerge, old ones depart,  
> In the realm of code, we play our part!" 🎉

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Nov 06 '24 12:11 coderabbitai[bot]

Output changes are expected because the p / q/p calculations change slightly.

I had a look at the sonar issues. I would prefer the explicit type for the distributions over using std defaults. The override thing looks very minor. I would prefer to sweep that out in one go.

Nov 28 '24 08:11 andiwand

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Nov 29 '24 10:11 sonarqubecloud[bot]

:white_check_mark: Athena integration test results [9c9444e35b0fd71374ce0fa4c9ff3c55854dc976]

:white_check_mark: All tests successful

status	job	report
:green_circle:	report_pull_request
:green_circle:	run_workflow_tests_run4_mc
:green_circle:	run_workflow_tests_run2_mc
:green_circle:	run_workflow_tests_run2_data
:green_circle:	run_workflow_tests_run3_mc
:green_circle:	run_workflow_tests_run3_data
:green_circle:	test_ActsDumpGeometryIdentifiers
:green_circle:	test_ActsCheckObjectCountsWorkflowHgtd
:green_circle:	test_ActsCheckObjectCountsCachedWorkflow
:green_circle:	test_ActsCheckObjectCountsWorkflow
:green_circle:	test_ActsEFTrackFit
:green_circle:	test_ActsPersistifySeeds
:green_circle:	test_ActsBenchmarkWithSpot
:green_circle:	test_ActsAnalogueClustering
:green_circle:	test_ActsWorkflowHeavyIons
:green_circle:	test_ActsWorkflowFastTracking
:green_circle:	test_ActsWorkflowCached
:green_circle:	test_ActsWorkflow
:green_circle:	test_ActsValidateAmbiguityResolution
:green_circle:	test_ActsValidateResolvedTracks
:green_circle:	test_ActsValidateTracks
:green_circle:	test_ActsValidateActsCoreSpacePoints
:green_circle:	test_ActsValidateActsSpacePoints
:green_circle:	test_ActsValidateSeeds
:green_circle:	test_ActsValidateOrthogonalSeeds
:green_circle:	test_ActsValidateClusters
:green_circle:	test_ActsPersistifyEDM
:green_circle:	test_ActsGSFRefitting
:green_circle:	test_ActsKfRefitting
:green_circle:	test_ActsExtrapolationAlgTest
:green_circle:	test_ActsITkTest

Nov 29 '24 13:11 acts-project-service

refactor: Replace `ParticleSmearing` with `TrackParameterSmearing ` in Examples

📊: Physics performance monitoring for 4f5daa0fbe5e1fe8a0aefa2e998455bc6db118cf

physmon summary

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Quality Gate passed

:white_check_mark: Athena integration test results [9c9444e35b0fd71374ce0fa4c9ff3c55854dc976]

:white_check_mark: All tests successful

CodeRabbit Configuration File (`.coderabbit.yaml`)