opengate.actors.miscactors
==========================

.. py:module:: opengate.actors.miscactors


Classes
-------

.. autoapisummary::

   opengate.actors.miscactors.SimulationStatisticsActor
   opengate.actors.miscactors.MotionVolumeActor
   opengate.actors.miscactors.SourceInfoActor
   opengate.actors.miscactors.TestActor
   opengate.actors.miscactors.KillActor


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

.. py:class:: SimulationStatisticsActor(user_info=None)

   Bases: :py:obj:`opengate_core.GateSimulationStatisticsActor`, :py:obj:`opengate.actors.base.ActorBase`


   Store statistics about a simulation run.


   .. py:attribute:: type_name
      :value: 'SimulationStatisticsActor'



   .. py:method:: set_default_user_info(user_info)
      :staticmethod:



   .. py:attribute:: simulation
      :value: None



   .. py:attribute:: counts


   .. py:attribute:: nb_thread
      :value: 1



   .. py:property:: pps


   .. py:property:: tps


   .. py:property:: sps


   .. py:property:: simu_start_time


   .. py:property:: simu_end_time


   .. py:method:: __str__()


   .. py:method:: StartSimulationAction()


   .. py:method:: EndSimulationAction()


   .. py:method:: write(filename)

      Attempt to be mostly compatible to previous Gate stat output file



.. py:class:: MotionVolumeActor(user_info)

   Bases: :py:obj:`opengate_core.GateMotionVolumeActor`, :py:obj:`opengate.actors.base.ActorBase`


   Every run, move a volume according to the given translations and rotations.


   .. py:attribute:: type_name
      :value: 'MotionVolumeActor'



   .. py:method:: set_default_user_info(user_info)
      :staticmethod:



   .. py:attribute:: g4_rotations
      :value: []



   .. py:attribute:: g4_translations
      :value: []



   .. py:method:: __str__()


   .. py:method:: close()


   .. py:method:: initialize(volume_engine=None)


.. py:class:: SourceInfoActor(name)

   Bases: :py:obj:`opengate_core.GateVActor`, :py:obj:`opengate.actors.base.ActorBase`


   TODO


   .. py:attribute:: type_name
      :value: 'SourceInfoActor'



   .. py:attribute:: actions
      :value: ['BeginOfRunAction', 'EndOfRunAction', 'BeginOfEventAction']



   .. py:attribute:: tree
      :value: None



   .. py:attribute:: file
      :value: None



   .. py:attribute:: positions
      :value: []



   .. py:method:: initialize(volume_engine=None)


   .. py:method:: BeginOfRunAction(run)


   .. py:method:: EndOfRunAction(run)


   .. py:method:: BeginOfEventAction(event)


.. py:class:: TestActor(user_info=None)

   Bases: :py:obj:`opengate_core.GateVActor`, :py:obj:`opengate.actors.base.ActorBase`


   Test actor: only py side (no cpp)
   For prototyping (slow)


   .. py:attribute:: type_name
      :value: 'TestActor'



   .. py:method:: set_default_user_info(user_info)
      :staticmethod:



   .. py:attribute:: run_count
      :value: 0



   .. py:attribute:: event_count
      :value: 0



   .. py:attribute:: track_count
      :value: 0



   .. py:attribute:: step_count
      :value: 0



   .. py:attribute:: duration
      :value: 0



   .. py:attribute:: track_types


   .. py:attribute:: start_time
      :value: 0



   .. py:attribute:: end_time
      :value: 0



   .. py:property:: pps


   .. py:property:: tps


   .. py:property:: sps


   .. py:method:: __str__()


   .. py:method:: StartSimulationAction()


   .. py:method:: BeginOfEventAction(event)


   .. py:method:: PreUserTrackingAction(track)


   .. py:method:: EndOfRunAction(run)


   .. py:method:: SteppingAction(step, touchable)


   .. py:method:: EndSimulationAction()


   .. py:method:: write(filename)


.. py:class:: KillActor(user_info)

   Bases: :py:obj:`opengate_core.GateKillActor`, :py:obj:`opengate.actors.base.ActorBase`


   .. py:attribute:: type_name
      :value: 'KillActor'



   .. py:method:: set_default_user_info()