opengate.postprocessors.unitbase
================================

.. py:module:: opengate.postprocessors.unitbase


Attributes
----------

.. autoapisummary::

   opengate.postprocessors.unitbase.__run_group_prefix__


Classes
-------

.. autoapisummary::

   opengate.postprocessors.unitbase.ProcessingUnitBase


Functions
---------

.. autoapisummary::

   opengate.postprocessors.unitbase._setter_hook_yields_to


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

.. py:data:: __run_group_prefix__
   :value: 'data_from_run'


.. py:function:: _setter_hook_yields_to(self, yields_to)

.. py:class:: ProcessingUnitBase(*args, processing_group=None, **kwargs)

   Bases: :py:obj:`opengate.base.GateObject`, :py:obj:`anytree.NodeMixin`


   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:: user_info_defaults


   .. py:attribute:: processing_group


   .. py:attribute:: output_data_handles


   .. py:attribute:: input_data_handles


   .. py:attribute:: hdf5_group
      :value: None



   .. py:property:: post_processor


   .. py:property:: is_processing_unit


   .. py:property:: can_be_initial_unit

      Generally, processing units cannot be the initial units in a processing tree.
      Those units which can be initial units, e.g. data fetcher, should override this property.



   .. py:property:: output_file_handle


   .. py:property:: input_units


   .. py:method:: get_or_create_output_table(*args, **kwargs)


   .. py:method:: get_or_create_output_array(*args, **kwargs)


   .. py:method:: get_or_create_output_carray(*args, **kwargs)


   .. py:method:: get_or_create_output_earray(*args, **kwargs)


   .. py:method:: get_or_create_output_group(*args, **kwargs)


   .. py:method:: _get_or_create_output_structure(which, name, link_name=None, subgroup=None, external_file=False, **kwargs)


   .. py:method:: register_output_data_handle(output_data_handle)

      output_data_handle should be a mode in the hdf5_group belonging to this unit.



   .. py:method:: get_unique_identifier_within_unit(node)


   .. py:method:: get_title_for_hdf5_node()


   .. py:method:: update_tree_node()

      Internal method which retrieves the volume object
      from the volume manager based on the mother's name stored as user info 'mother'



   .. py:method:: _request_processing_unit_tree_update()


   .. py:method:: initialize_hdf5_group_in_output_file()


   .. py:method:: get_unit_output_group()


   .. py:method:: store_user_attributes()


   .. py:method:: close()

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



   .. py:method:: update_output()


   .. py:method:: do_your_job()

      Implement this in the concrete class.