opengate.actors.dynamicactors
=============================

.. py:module:: opengate.actors.dynamicactors


Classes
-------

.. autoapisummary::

   opengate.actors.dynamicactors.DynamicGeometryActor
   opengate.actors.dynamicactors.GeometryChanger
   opengate.actors.dynamicactors.VolumeImageChanger
   opengate.actors.dynamicactors.VolumeTranslationChanger
   opengate.actors.dynamicactors.VolumeRotationChanger


Functions
---------

.. autoapisummary::

   opengate.actors.dynamicactors._setter_hook_attached_to


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

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

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


   This is the base class used for all objects that handle user input in GATE.

   The class is assumed to be processed by process_cls(), either explicitly
   or via the metaclass MetaUserInfo, before any instances of the class are created.
   Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.


   .. py:attribute:: geometry_changers
      :value: []



   .. py:method:: __initcpp__()

      Nothing to do in the base class.



   .. py:method:: close()

      Dummy implementation for inherited classes which do not implement this method.



   .. py:method:: to_dictionary()


   .. py:method:: initialize()

      This base class method initializes common settings and should be called in all inheriting classes.



   .. py:method:: BeginOfRunActionMasterThread(run_id)


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

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

   Bases: :py:obj:`opengate.base.GateObject`


   This is the base class used for all objects that handle user input in GATE.

   The class is assumed to be processed by process_cls(), either explicitly
   or via the metaclass MetaUserInfo, before any instances of the class are created.
   Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.


   .. py:attribute:: attached_to
      :type:  Optional[str]


   .. py:attribute:: user_info_defaults


   .. py:property:: volume_manager


   .. py:property:: attached_to_volume


   .. py:method:: initialize()


   .. py:method:: apply_change(run_id)
      :abstractmethod:



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

   Bases: :py:obj:`GeometryChanger`


   This is the base class used for all objects that handle user input in GATE.

   The class is assumed to be processed by process_cls(), either explicitly
   or via the metaclass MetaUserInfo, before any instances of the class are created.
   Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.


   .. py:attribute:: images
      :type:  Optional[list]


   .. py:attribute:: label_image
      :type:  Optional[dict]


   .. py:attribute:: user_info_defaults


   .. py:method:: apply_change(run_id)


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

   Bases: :py:obj:`GeometryChanger`


   This is the base class used for all objects that handle user input in GATE.

   The class is assumed to be processed by process_cls(), either explicitly
   or via the metaclass MetaUserInfo, before any instances of the class are created.
   Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.


   .. py:attribute:: translations
      :type:  Optional[list]


   .. py:attribute:: repetition_index
      :type:  int


   .. py:attribute:: user_info_defaults


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



   .. py:attribute:: g4_physical_volume
      :value: None



   .. py:method:: close()

      Dummy implementation for inherited classes which do not implement this method.



   .. py:method:: __getstate__()

      Method needed for pickling. May be overridden in inheriting classes.



   .. py:method:: initialize()


   .. py:method:: apply_change(run_id)


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

   Bases: :py:obj:`GeometryChanger`


   This is the base class used for all objects that handle user input in GATE.

   The class is assumed to be processed by process_cls(), either explicitly
   or via the metaclass MetaUserInfo, before any instances of the class are created.
   Some class attributes, e.g. inherited_user_info_defaults, are created as part of this processing.


   .. py:attribute:: rotations
      :type:  Optional[list]


   .. py:attribute:: repetition_index
      :type:  int


   .. py:attribute:: user_info_defaults


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



   .. py:attribute:: g4_physical_volume
      :value: None



   .. py:attribute:: r
      :value: []



   .. py:method:: close()

      Dummy implementation for inherited classes which do not implement this method.



   .. py:method:: __getstate__()

      Method needed for pickling. May be overridden in inheriting classes.



   .. py:method:: initialize()


   .. py:method:: apply_change(run_id)