:py:mod:`thread_tasks`
======================

.. py:module:: thread_tasks


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

Classes
~~~~~~~

.. autoapisummary::

   thread_tasks.OpenFile
   thread_tasks.BinAll



Functions
~~~~~~~~~

.. autoapisummary::

   thread_tasks.bin_all



Attributes
~~~~~~~~~~

.. autoapisummary::

   thread_tasks.logger


.. py:data:: logger
   :value: "'thread_tasks'"

   

.. py:class:: OpenFile(file_path: str, is_irf: bool = False, tmin=None, progress_tracker: processes.ProgressTracker = None)


   A QRunnable class to create a worker thread for opening h5 file.

   .. py:property:: file_path
      :type: str


   .. py:property:: irf
      :type: bool


   .. py:property:: tmin


   .. py:attribute:: _file_path

      

   .. py:attribute:: _is_irf
      :value: 'False'

      

   .. py:attribute:: _tmin
      :value: 'None'

      

   .. py:attribute:: progress_tracker
      :value: 'None'

      

   .. py:method:: open_h5(feedback_queue: multiprocessing.JoinableQueue) -> smsh5.H5dataset

      Read the selected h5 file and populates the tree on the gui with the file and the particles.

      Accepts a function that will be used to indicate the current progress.

      As this function is designed to be called from a thread other than the main one, no GUI code
      should be called here.

      :param fname: Path name to h5 file.
      :type fname: str
      :param feedback_queue: Queue to send feedback to ProcessThread
      :type feedback_queue: multiprocessing.JoinableQueue


   .. py:method:: open_irf(feedback_queue: multiprocessing.JoinableQueue) -> None

      Read the selected h5 file and populates the tree on the gui with the file and the particles.

      Accepts a function that will be used to indicate the current progress.

      As this function is designed to be called from a thread other than the main one, no GUI code
      should be called here.

      :param fname: Path name to h5 file.
      :type fname: str


   .. py:method:: load_data(fname: str, sig_fb: processes.PassSigFeedback, prog_fb: processes.ProcessProgFeedback)



.. py:class:: BinAll(dataset: smsh5.H5dataset, bin_size: float, progress_tracker: processes.ProgressTracker = None)


   .. py:attribute:: dataset

      

   .. py:attribute:: bin_size

      

   .. py:attribute:: bin_all_func

      

   .. py:attribute:: progress_tracker
      :value: 'None'

      

   .. py:method:: run_bin_all(feedback_queue: multiprocessing.JoinableQueue)



.. py:function:: bin_all(dataset: smsh5.H5dataset, bin_size: float, for_irf: bool = False, sig_fb: processes.PassSigFeedback = None, prog_fb: processes.ProcessProgFeedback = None) -> None

   :param bin_size:
   :param dataset:
   :param sig_fb:
   :param prog_fb: