diff --git a/docs/tools_to_interact_with_the_simulation_actors.rst b/docs/tools_to_interact_with_the_simulation_actors.rst index b46f6140a..16fecf71e 100644 --- a/docs/tools_to_interact_with_the_simulation_actors.rst +++ b/docs/tools_to_interact_with_the_simulation_actors.rst @@ -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 \ No newline at end of file