opengate.userhooks
==================

.. py:module:: opengate.userhooks


Functions
---------

.. autoapisummary::

   opengate.userhooks.get_ions_generated_per_spot
   opengate.userhooks.check_production_cuts
   opengate.userhooks.user_hook_dump_material_properties
   opengate.userhooks.user_hook_em_switches
   opengate.userhooks.user_hook_active_regions


Module Contents
---------------

.. py:function:: get_ions_generated_per_spot(simulation_engine)

.. py:function:: check_production_cuts(simulation_engine)

   Function to be called by opengate after initialization
   of the simulation, i.e. when G4 volumes and regions exist.
   The purpose is to check whether Geant4 has properly set
   the production cuts in the specific region.

   The value max_step_size is stored in the attribute hook_log
   which can be accessed via the output of the simulation.



.. py:function:: user_hook_dump_material_properties(simulation_engine)

.. py:function:: user_hook_em_switches(simulation_engine)

.. py:function:: user_hook_active_regions(simulation_engine)