opengate.postprocessors.datafetchers
====================================

.. py:module:: opengate.postprocessors.datafetchers


Classes
-------

.. autoapisummary::

   opengate.postprocessors.datafetchers.DataFetcherBase
   opengate.postprocessors.datafetchers.DataFetcherWithFileHandle
   opengate.postprocessors.datafetchers.DataFetcherHdf5


Functions
---------

.. autoapisummary::

   opengate.postprocessors.datafetchers._setter_hook_input_path
   opengate.postprocessors.datafetchers._setter_hook_input_actor
   opengate.postprocessors.datafetchers._setter_hook_path_in_hdf5_file


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

.. py:function:: _setter_hook_input_path(self, p)

.. py:function:: _setter_hook_input_actor(self, input_actor)

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

   Bases: :py:obj:`opengate.postprocessors.unitbase.ProcessingUnitBase`


   This is a base class for data fetchers.


   .. py:attribute:: user_info_defaults


   .. py:attribute:: _input_path
      :value: None



   .. 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:method:: _get_input_path()


   .. py:method:: close()

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



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

   Bases: :py:obj:`DataFetcherBase`


   This is a base class for data fetchers.


   .. py:method:: _open_input_file_handle()


   .. py:method:: open_file(path)
      :abstractmethod:


      Needs concrete implementation in derived class.



   .. py:property:: input_file_handle


.. py:function:: _setter_hook_path_in_hdf5_file(self, p)

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

   Bases: :py:obj:`DataFetcherWithFileHandle`


   This is a base class for data fetchers.


   .. py:attribute:: user_info_defaults


   .. py:method:: open_file(path)

      Needs concrete implementation in derived class.



   .. py:method:: do_your_job()

      Implement this in the concrete class.