Skip to content

Commit

Permalink
Merge pull request #625 from tontyoutoure/tontyoutoure_documentation_…
Browse files Browse the repository at this point in the history
…materailFilter

add documentation for materialFilter
  • Loading branch information
tbaudier authored Jun 30, 2023
2 parents c7537af + 73c46d4 commit d3530b2
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/tools_to_interact_with_the_simulation_actors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1066,4 +1066,18 @@ Example: To kill particles in a cone of 20 degrees around x axis::
/gate/actor/MyActor/angleFilter/setAngle 20
/gate/actor/MyActor/angleFilter/setDirection 1 0 0

Filter on material type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The attached volume of the actor may contains different materials. This filter is used to select particles hit different materials::

/gate/actor/[Actor Name]/addFilter materialFilter
/gate/actor/[Actor Name]/materialFilter/addMaterial [Material Name]

Example: To kill particles in the volume MyVolume that hits Water::

/gate/actor/addActor KillActor MyActor
/gate/actor/MyActor/save MyOutputFile.txt
/gate/actor/MyActor/attachTo MyVolume
/gate/actor/MyActor/addFilter materialFilter
/gate/actor/MyActor/materialFilter/addMaterial Water

0 comments on commit d3530b2

Please sign in to comment.