User hook (JITable) for track references during stepping#10085
Merged
Conversation
This commit implements a generic and customizable mechanism
to define and execute a callback during MC stepping. The purpose
of the callback is to create TrackReferences for certain conditions,
but can be used for other purposes (monitoring etc).
The callback just takes the instance to TVirtualMC
The default implementation creates a TrackReference on "IsStop"
whenever the current track already left a TrackReference previously.
The feature needs to be switched on via configurable Parameter
`SimCutParams.stepTrackRefHook=1`
Furthermore, the user can provide own callback implementations
via a macro file "MyHook.C". The implementation should follow the
following pattern:
```
o2::steer::O2MCApplicationBase::TrackRefFcn trackRefHook() { return [](TVirtualMC const* vmc) { auto stack = (o2::data::Stack*)vmc->GetStack(); if (vmc->IsTrackStop() && stack->currentTrackLeftTrackRef()) { // we add a stopping TrackRef when the current track already // registered previous TrackRefs stack->addTrackReference(o2::TrackReference(*vmc, 0)); } }; }
```
MyHook.C will be activated with
`SimCutParams.mCutParams.stepTrackRefHookFile=PATHTO/MyHook.C`
Collaborator
|
Error while checking build/O2/fullCI for 539e857 at 2022-10-14 21:17: Full log here. |
Collaborator
|
Error while checking build/O2/fullCI for f3de58e at 2022-10-15 02:35: Full log here. |
Contributor
|
Reading the source code the default callback (if enabled) is one For me it is good default |
Contributor
|
The standard hook is fine with me. I understand that this might not be the case once the hook changes, but it is definitely an expert action. Also, we will never create more TrackRefernces than there are particles in the stack. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit implements a generic and customizable mechanism to define and execute a callback during MC stepping. The purpose of the callback is to create TrackReferences for certain conditions, but can be used for other purposes (monitoring etc). The callback just takes the instance to TVirtualMC
The default implementation creates a TrackReference on "IsStop" whenever the current track already left a TrackReference previously.
The feature needs to be switched on via configurable Parameter
SimCutParams.stepTrackRefHook=1Furthermore, the user can provide own callback implementations via a macro file "MyHook.C". The implementation should follow the following pattern:
MyHook.C will be activated with
SimCutParams.mCutParams.stepTrackRefHookFile=PATHTO/MyHook.C