opengate.actors.arfactors
=========================

.. py:module:: opengate.actors.arfactors


Classes
-------

.. autoapisummary::

   opengate.actors.arfactors.ARFTrainingDatasetActor
   opengate.actors.arfactors.ARFActor


Functions
---------

.. autoapisummary::

   opengate.actors.arfactors.import_garf


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

.. py:function:: import_garf()

.. py:class:: ARFTrainingDatasetActor(user_info)

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


   The ARFTrainingDatasetActor build a root file with energy, angles, positions and energy windows
   of a spect detector. To be used by garf_train to train a ARF neural network.

   Note: Must inherit from ActorBase not from HitsCollectionActor, even if the
   cpp part inherit from HitsCollectionActor


   .. py:attribute:: type_name
      :value: 'ARFTrainingDatasetActor'



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



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


   .. py:method:: __str__()


.. py:class:: ARFActor(user_info)

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


   The ARF Actor is attached to a volume.
   Every time a particle enter, it considers the energy and the direction of the particle.
   It runs the neural network model to provide the probability of detection in all energy windows.

   Output is an ITK image that can be retrieved with self.output_image


   .. py:attribute:: type_name
      :value: 'ARFActor'



   .. py:method:: set_default_user_info()


   .. py:attribute:: debug_nb_hits_before
      :value: None



   .. py:attribute:: debug_nb_hits
      :value: 0



   .. py:attribute:: garf


   .. py:attribute:: g4_actor
      :value: None



   .. py:attribute:: pth_filename


   .. py:attribute:: param


   .. py:attribute:: nn
      :value: None



   .. py:attribute:: model
      :value: None



   .. py:attribute:: model_data
      :value: None



   .. py:attribute:: batch_nb
      :value: 0



   .. py:attribute:: detected_particles
      :value: 0



   .. py:attribute:: lock


   .. py:method:: __str__()


   .. py:method:: __getstate__()


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


   .. py:method:: apply(actor)


   .. py:method:: apply_with_lock(actor)


   .. py:method:: EndSimulationAction()