Skip to content

Update comments in examples for ColorBy graphics #1

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.

Sign up for GitHub

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

Open
embrh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update comments in examples for ColorBy graphics #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/Graphics/ColorByCharge.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Demonstrates changing color scheme of trajectories.
# Trajectories are colored based on the process that created the trajectory.
# Trajectories are colored based on the charge of the particle. Defaults to red, green and blue for negative, neutral and positive.

s:Ge/Box/Type = "TsBox"
s:Ge/Box/Parent = "World"
Expand Down Expand Up @@ -62,7 +62,7 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "Charge"
sv:Gr/MyOGL/ColorByChargeColors = 3 "yellow" "purple" "teal"
sv:Gr/MyOGL/ColorByChargeColors = 3 "yellow" "purple" "teal" # colors for negative, neutral, positive

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
3 changes: 2 additions & 1 deletion examples/Graphics/ColorByCreatorProcess.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "CreatorProcess"
sv:Gr/MyOGL/ColorByCreatorProcessNames = 10 "primary" "protonInelastic" "phot" "compt" "eIoni" "eBrem" "hadElastic" "hIoni" "neutronInelastic" "nCapture"sv:Gr/MyOGL/ColorByCreatorProcessColors = 10 "blue" "purple" "green" "red" "yellow" "teal" "fuchsia" "olive" "maroon" "aqua"
sv:Gr/MyOGL/ColorByCreatorProcessNames = 10 "primary" "protonInelastic" "phot" "compt" "eIoni" "eBrem" "hadElastic" "hIoni" "neutronInelastic" "nCapture" # one or more process name
sv:Gr/MyOGL/ColorByCreatorProcessColors = 10 "blue" "purple" "green" "red" "yellow" "teal" "fuchsia" "olive" "maroon" "aqua" # one for every process name

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
6 changes: 3 additions & 3 deletions examples/Graphics/ColorByEnergy.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Demonstrates changing color scheme of trajectories.
# Trajectories are colored based on the process that created the trajectory.
# Trajectories are colored based on the energy of the particle.

s:Ge/Box/Type = "TsBox"
s:Ge/Box/Parent = "World"
Expand Down Expand Up @@ -62,8 +62,8 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "Energy"
dv:Gr/MyOGL/ColorByEnergyRanges = 4 1. 10. 250. 398. MeV
sv:Gr/MyOGL/ColorByEnergyColors = 5 "red" "yellow" "green" "blue" "white"
dv:Gr/MyOGL/ColorByEnergyRanges = 4 1. 10. 250. 398. MeV # limits of energy ranges
sv:Gr/MyOGL/ColorByEnergyColors = 5 "red" "yellow" "green" "blue" "white" # one for every energy interval that is defined by those ranges - one more value than number of ranges since includes less than first range value and greater than first range value

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
4 changes: 2 additions & 2 deletions examples/Graphics/ColorByGeneration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Demonstrates changing color scheme of trajectories.
# Trajectories are colored based on the process that created the trajectory.
# Trajectories are colored based on the generation of the particle.

s:Ge/Box/Type = "TsBox"
s:Ge/Box/Parent = "World"
Expand Down Expand Up @@ -62,7 +62,7 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "Generation"
sv:Gr/MyOGL/ColorByGenerationColors = 2 "green" "red"
sv:Gr/MyOGL/ColorByGenerationColors = 2 "green" "red" # colors for primary and secondaries

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
6 changes: 3 additions & 3 deletions examples/Graphics/ColorByMomentum.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Demonstrates changing color scheme of trajectories.
# Trajectories are colored based on the process that created the trajectory.
# Trajectories are colored based on the momentum of the particle.

s:Ge/Box/Type = "TsBox"
s:Ge/Box/Parent = "World"
Expand Down Expand Up @@ -62,8 +62,8 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "Momentum"
dv:Gr/MyOGL/ColorByMomentumRanges = 4 1. 10. 450. 1000. MeV
sv:Gr/MyOGL/ColorByMomentumColors = 5 "red" "yellow" "green" "blue" "white"
dv:Gr/MyOGL/ColorByMomentumRanges = 4 1. 10. 450. 1000. MeV # limits of momentum ranges
sv:Gr/MyOGL/ColorByMomentumColors = 5 "red" "yellow" "green" "blue" "white" # one for every energy interval that is defined by those ranges - one more value than number of ranges since includes less than first range value and greater than first range value

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
8 changes: 3 additions & 5 deletions examples/Graphics/ColorByOriginComponent.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Demonstrates changing color scheme of trajectories.
# Trajectories that originate in the component named Outer
# or any of its subcomponents will be colored red.
# All others will be colored grey.
# Trajectories are colored based on the component where the particle originated. Trajectories that originate from a component other than those specified will be colored grey.

s:Ge/Box/Type = "TsBox"
s:Ge/Box/Parent = "World"
Expand Down Expand Up @@ -64,8 +62,8 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "OriginComponent"
sv:Gr/MyOGL/ColorByOriginComponentNames = 5 "World" "Outer" "Film1" "Film2" "Box"
sv:Gr/MyOGL/ColorByOriginComponentColors = 5 "Red" "Blue" "Yellow" "Pink" "Green"
sv:Gr/MyOGL/ColorByOriginComponentNames = 5 "World" "Outer" "Film1" "Film2" "Box" # one or more component names
sv:Gr/MyOGL/ColorByOriginComponentColors = 5 "Red" "Blue" "Yellow" "Pink" "Green" # one color for each name above

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
8 changes: 3 additions & 5 deletions examples/Graphics/ColorByOriginComponentOrSubComponent.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Demonstrates changing color scheme of trajectories.
# Trajectories that originate in the component named Outer
# or any of its subcomponents will be colored red.
# All others will be colored grey.
# Trajectories are colored based on the component where the particle originated, or any of its subcomponents. Trajectories that originate from a component other than those specified will be colored grey.

s:Ge/Box/Type = "TsBox"
s:Ge/Box/Parent = "World"
Expand Down Expand Up @@ -64,8 +62,8 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "OriginComponentOrSubComponentOf"
sv:Gr/MyOGL/ColorByOriginComponentNames = 3 "World" "Outer" "Box"
sv:Gr/MyOGL/ColorByOriginComponentColors = 3 "Red" "Blue" "Green"
sv:Gr/MyOGL/ColorByOriginComponentNames = 3 "World" "Outer" "Box" # one or more components
sv:Gr/MyOGL/ColorByOriginComponentColors = 3 "Red" "Blue" "Green" # one color for each name above

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
8 changes: 3 additions & 5 deletions examples/Graphics/ColorByOriginVolume.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Demonstrates changing color scheme of trajectories.
# Trajectories that originate in the component named Outer
# or any of its subcomponents will be colored red.
# All others will be colored grey.
# Trajectories are colored based on the volume where the particle originated. Trajectories that originate from a volume other than those specified will be colored grey.

s:Ge/Box/Type = "TsBox"
s:Ge/Box/Parent = "World"
Expand Down Expand Up @@ -64,8 +62,8 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "OriginVolume"
sv:Gr/MyOGL/ColorByOriginVolumeNames = 6 "World" "Outer" "Film1" "Film2" "Film1/Film1_Z_Division" "Box"
sv:Gr/MyOGL/ColorByOriginVolumeColors = 6 "Red" "Blue" "Yellow" "Pink" "Magenta" "Green"
sv:Gr/MyOGL/ColorByOriginVolumeNames = 6 "World" "Outer" "Film1" "Film2" "Film1/Film1_Z_Division" "Box" # one or more volume
sv:Gr/MyOGL/ColorByOriginVolumeColors = 6 "Red" "Blue" "Yellow" "Pink" "Magenta" "Green" # one color for each name above

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
5 changes: 3 additions & 2 deletions examples/Graphics/ColorByParticleType.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Demonstrates changing color scheme of trajectories.
# Trajectories are colored based on the process that created the trajectory.
# Trajectories are colored based on the particle type. Defaults to green, red, blue, magenta, cyan, yellow and gray for gamma, e-, e+, pi+, proton, neutron, and other particles respectively.

s:Ge/Box/Type = "TsBox"
s:Ge/Box/Parent = "World"
Expand Down Expand Up @@ -62,7 +62,8 @@ i:Gr/MyOGL/WindowSizeY = 600
i:Gr/MyOGL/WindowPosX = 0
i:Gr/MyOGL/WindowPosY = 0
s:Gr/MyOGL/ColorBy = "ParticleType"
sv:Gr/MyOGL/ColorByParticleTypeNames = 4 "e-" "gamma" "proton" "neutron"sv:Gr/MyOGL/ColorByParticleTypeColors = 4 "yellow" "pink" "aqua" "grass"
sv:Gr/MyOGL/ColorByParticleTypeNames = 4 "e-" "gamma" "proton" "neutron" # any number of particle names
sv:Gr/MyOGL/ColorByParticleTypeColors = 4 "yellow" "pink" "aqua" "grass" # for each particle type above. All other particles will be set to grey.

s:So/Example/Type = "Beam"
s:So/Example/Component = "BeamPosition"
Expand Down
2 changes: 1 addition & 1 deletion parameters/graphics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Trajectory Coloring::

s:Gr/MyGraphic1/ColorBy = "Charge" # "Charge", "ParticleType", "OriginComponent", "Energy", "Momentum", "Generation", "CreatorProcess"

For ``ColorBy = "Charge"``, trajectories default to red, greed, blue for negative, neutral and positive. You can override these defaults with::
For ``ColorBy = "Charge"``, trajectories default to red, green, blue for negative, neutral and positive. You can override these defaults with::

sv:Gr/MyGraphic1/ColorByChargeColors = 3 "blue" "green" "red" # colors for neg, neutral, pos

Expand Down