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

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


Classes
-------

.. autoapisummary::

   opengate.actors.miscactors.ActorOutputStatisticsActor
   opengate.actors.miscactors.SimulationStatisticsActor
   opengate.actors.miscactors.KillActor
   opengate.actors.miscactors.SplittingActorBase
   opengate.actors.miscactors.ComptSplittingActor
   opengate.actors.miscactors.BremSplittingActor


Functions
---------

.. autoapisummary::

   opengate.actors.miscactors._setter_hook_stats_actor_output_filename
   opengate.actors.miscactors._setter_hook_particles


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

.. py:function:: _setter_hook_stats_actor_output_filename(self, output_filename)

.. py:class:: ActorOutputStatisticsActor(*args, **kwargs)

   Bases: :py:obj:`opengate.actors.actoroutput.ActorOutputBase`


   This is a hand-crafted ActorOutput specifically for the SimulationStatisticsActor.


   .. py:attribute:: encoder
      :type:  str


   .. py:attribute:: output_filename
      :type:  str


   .. py:attribute:: write_to_disk
      :type:  bool


   .. py:attribute:: user_info_defaults


   .. py:attribute:: default_suffix
      :value: 'json'



   .. py:attribute:: merged_data


   .. py:property:: pps


   .. py:property:: tps


   .. py:property:: sps


   .. py:method:: store_data(data, **kwargs)


   .. py:method:: get_data(**kwargs)


   .. py:method:: get_processed_output()


   .. py:method:: __str__()


   .. py:method:: write_data(**kwargs)

      Override virtual method from base class.



   .. py:method:: write_data_if_requested(**kwargs)


.. py:class:: SimulationStatisticsActor(*args, **kwargs)

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


   Store statistics about a simulation run.


   .. py:attribute:: track_types_flag
      :type:  bool


   .. py:attribute:: user_info_defaults


   .. py:method:: __initcpp__()


   .. py:method:: __str__()


   .. py:property:: counts


   .. py:method:: store_output_data(output_name, run_index, *data)
      :abstractmethod:



   .. py:method:: initialize()


   .. py:method:: StartSimulationAction()


   .. py:method:: EndSimulationAction()


.. py:class:: KillActor(*args, **kwargs)

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


   .. py:attribute:: number_of_killed_particles
      :value: 0



   .. py:method:: __initcpp__()


   .. py:method:: initialize()


   .. py:method:: EndSimulationAction()


.. py:function:: _setter_hook_particles(self, value)

.. py:class:: SplittingActorBase

   Bases: :py:obj:`opengate.actors.base.ActorBase`


   .. py:attribute:: splitting_factor
      :type:  int


   .. py:attribute:: bias_primary_only
      :type:  bool


   .. py:attribute:: bias_only_once
      :type:  bool


   .. py:attribute:: particles
      :type:  list


   .. py:attribute:: user_info_defaults


.. py:class:: ComptSplittingActor(*args, **kwargs)

   Bases: :py:obj:`SplittingActorBase`, :py:obj:`opengate_core.GateOptrComptSplittingActor`


   .. py:attribute:: weight_threshold
      :type:  float


   .. py:attribute:: min_weight_of_particle
      :type:  float


   .. py:attribute:: russian_roulette
      :type:  bool


   .. py:attribute:: rotation_vector_director
      :type:  bool


   .. py:attribute:: vector_director
      :type:  list


   .. py:attribute:: max_theta
      :type:  float


   .. py:attribute:: user_info_defaults


   .. py:attribute:: processes
      :value: ('compt',)



   .. py:method:: __initcpp__()


   .. py:method:: initialize()


.. py:class:: BremSplittingActor(*args, **kwargs)

   Bases: :py:obj:`SplittingActorBase`, :py:obj:`opengate_core.GateBOptrBremSplittingActor`


   .. py:attribute:: processes
      :type:  list


   .. py:attribute:: user_info_defaults


   .. py:method:: __initcpp__()


   .. py:method:: initialize()