docs: add PositroniumSource user documentation#4
Open
MateuszBala wants to merge 2 commits into
Open
Conversation
wkrzemien
requested changes
May 19, 2026
|
|
||
| As for other sources, the activity and the spatial or temporal distributions are configured with the standard source commands, for example:: | ||
|
|
||
| /gate/source/NAME/setActivity 1000 becquerel |
| Lifetime of each component. The last token is a Geant4 time unit such as ``ns``. | ||
|
|
||
| ``/gate/source/NAME/setPromptPhotonProbabilites p1 p2 ... pn`` | ||
| Probability of prompt-gamma emission for each component. Values are clamped to the ``[0, 1]`` range by the messenger. |
There was a problem hiding this comment.
I don't know the word clamp, maybe restricted or projected?
| ^^^^^^^^^^^^^^^^^ | ||
|
|
||
| ``/gate/source/NAME/setElectronCaptureProbabilities p1 p2 ... pn`` | ||
| Probability that the positron is lost by electron capture and no annihilation vertex is produced for a given component. If this command is omitted, all probabilities default to ``0``. Values are clamped to the ``[0, 1]`` range. |
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
2 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.
Summary
This PR adds user documentation for the positronium source workflow and related Hits-tree metadata.
Documentation Changes
PositroniumSourcesection todocs/source_and_particle_management.rst.PositroniumSource, including:gammaType,sourceType,decayType,decayIndex.PositroniumSourceand clarified how they should be interpreted.ExtendedVSourcedoes not populatedecayIndex, so this branch remains at the default value-1there.docs/data_output_management.rstto includedecayIndexin the documented Hits-tree branch list.Validation