opengate.actors.doseactors
==========================

.. py:module:: opengate.actors.doseactors


Classes
-------

.. autoapisummary::

   opengate.actors.doseactors.DoseActor
   opengate.actors.doseactors.LETActor
   opengate.actors.doseactors.FluenceActor


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

.. py:class:: DoseActor(user_info)

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


   DoseActor: compute a 3D edep/dose map for deposited
   energy/absorbed dose in the attached volume

   The dose map is parameterized with:
       - size (number of voxels)
       - spacing (voxel size)
       - translation (according to the coordinate system of the "attachedTo" volume)
       - no rotation

   Position:
   - by default: centered according to the "attachedTo" volume center
   - if the attachedTo volume is an Image AND the option "img_coord_system" is True:
       the origin of the attachedTo image is used for the output dose.
       Hence, the dose can be superimposed with the attachedTo volume

   Options
       - edep only for the moment
       - later: add dose, uncertainty, squared etc



   .. py:attribute:: type_name
      :value: 'DoseActor'



   .. py:method:: set_default_user_info()


   .. py:attribute:: g4_phys_vol
      :value: None



   .. py:attribute:: py_edep_image
      :value: None



   .. py:attribute:: py_dose_image
      :value: None



   .. py:attribute:: py_temp_image
      :value: None



   .. py:attribute:: py_square_image
      :value: None



   .. py:attribute:: py_last_id_image
      :value: None



   .. py:attribute:: uncertainty_image
      :value: None



   .. py:attribute:: img_origin_during_run
      :value: None



   .. py:attribute:: first_run
      :value: None



   .. py:attribute:: output_origin
      :value: None



   .. py:method:: __str__()


   .. py:method:: __getstate__()

      This is important : to get actor's outputs from a simulation run in a separate process,
      the class must be serializable (pickle).
      The engines (volume, actor, etc.) and G4 objects are also removed if exists.



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

      At the start of the run, the image is centered according to the coordinate system of
      the mother volume. This function computes the correct origin = center + translation.
      Note that there is a half-pixel shift to align according to the center of the pixel,
      like in ITK.



   .. py:method:: StartSimulationAction()


   .. py:method:: EndSimulationAction()


   .. py:method:: compute_square()


   .. py:method:: compute_uncertainty()


.. py:class:: LETActor(user_info)

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


   LETActor: compute a 3D edep/dose map for deposited
   energy/absorbed dose in the attached volume

   The dose map is parameterized with:
       - size (number of voxels)
       - spacing (voxel size)
       - translation (according to the coordinate system of the "attachedTo" volume)
       - no rotation

   Position:
   - by default: centered according to the "attachedTo" volume center
   - if the attachedTo volume is an Image AND the option "img_coord_system" is True:
       the origin of the attachedTo image is used for the output dose.
       Hence, the dose can be superimposed with the attachedTo volume

   Options
       - LETd only for the moment
       - later: LETt, Q, fluence ...



   .. py:attribute:: type_name
      :value: 'LETActor'



   .. py:method:: set_default_user_info()


   .. py:attribute:: g4_phys_vol
      :value: None



   .. py:attribute:: py_numerator_image
      :value: None



   .. py:attribute:: py_denominator_image
      :value: None



   .. py:attribute:: py_output_image
      :value: None



   .. py:attribute:: img_origin_during_run
      :value: None



   .. py:attribute:: first_run
      :value: None



   .. py:attribute:: output_origin
      :value: None



   .. py:method:: __str__()


   .. py:method:: __getstate__()

      This is important : to get actor's outputs from a simulation run in a separate process,
      the class must be serializable (pickle).
      The engines (volume, actor, etc.) and G4 objects are also removed if exists.



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

      At the start of the run, the image is centered according to the coordinate system of
      the mother volume. This function computes the correct origin = center + translation.
      Note that there is a half-pixel shift to align according to the center of the pixel,
      like in ITK.



   .. py:method:: StartSimulationAction()


   .. py:method:: EndSimulationAction()


.. py:class:: FluenceActor(user_info)

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


   FluenceActor: compute a 3D map of fluence

   FIXME: add scatter order and uncertainty


   .. py:attribute:: type_name
      :value: 'FluenceActor'



   .. py:method:: set_default_user_info()


   .. py:attribute:: g4_phys_vol
      :value: None



   .. py:attribute:: py_fluence_image
      :value: None



   .. py:method:: __str__()


   .. py:method:: __getstate__()

      This is important : to get actor's outputs from a simulation run in a separate process,
      the class must be serializable (pickle).
      The engines (volume, actor, etc.) and G4 objects are also removed if exists.



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


   .. py:method:: StartSimulationAction()


   .. py:method:: EndSimulationAction()