cibrrig.preprocess.extract_sync_times
=====================================

.. py:module:: cibrrig.preprocess.extract_sync_times

.. autoapi-nested-parse::

   Extract digital signals from the NI and IMEC Streams



Attributes
----------

.. autoapisummary::

   cibrrig.preprocess.extract_sync_times._log
   cibrrig.preprocess.extract_sync_times.MAP_TO_INTERVALS
   cibrrig.preprocess.extract_sync_times.OMIT_SIGNALS


Functions
---------

.. autoapisummary::

   cibrrig.preprocess.extract_sync_times.sync2alf
   cibrrig.preprocess.extract_sync_times.run
   cibrrig.preprocess.extract_sync_times.main


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

.. py:data:: _log

.. py:data:: MAP_TO_INTERVALS
   :value: []


.. py:data:: OMIT_SIGNALS
   :value: ['imec_sync', 'record']


.. py:function:: sync2alf(session_path)

   Extract all data from the digital sync line in the ALF format

   Data that matches OMIT_SIGNALS is not extracted.
   Data that matches MAP_TO_INTERVALS is extracted as intervals (2 columns, start and end times)


.. py:function:: run(session_path, debug=False, no_display=False)

   Extract synchronization times from the session data.

   Extract times, directions, and channels for all digital signals in the session data.

   :param session_path: Path to the session data.
   :type session_path: str, Path
   :param debug: If True, sets logging level to DEBUG. Defaults to False.
   :type debug: bool, optional
   :param no_display: If True, disables display of plots. Defaults to False.
   :type no_display: bool, optional

   :returns: None


.. py:function:: main(session_path, debug, no_display)

   Script entry point to extract digital (sync) signals.

   :param session_path: Path to the session data.
   :type session_path: str
   :param debug: If True, sets logging level to DEBUG.
   :type debug: bool
   :param no_display: If True, disables display of plots.
   :type no_display: bool

   :returns: None