fluopy.blinking
===============

.. py:module:: fluopy.blinking

.. autoapi-nested-parse::

   Extract fluorescence intermittency (blinking).



Classes
-------

.. autoapisummary::

   fluopy.blinking.Blinking


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

.. py:class:: Blinking(emissions: fluopy.emissions.Emissions, threshold: int = 0, memory: int = 0)

   Container for blinking-associated attributes.

   :ivar emissions: Container for emission-associated attributes.
   :vartype emissions: fluopy.emissions.Emissions
   :ivar on_periods: Contains the durations of each ON period (in frames).
   :vartype on_periods: npt.NDArray[np.int64]
   :ivar off_periods: Contains the durations of each OFF period (in frames).
   :vartype off_periods: npt.NDArray[np.int64]
   :ivar on_periods_frames: Contains the first frame of each ON period.
   :vartype on_periods_frames: npt.NDArray[np.int64]
   :ivar off_periods_frames: Contains the first frame of each OFF period.

   :vartype off_periods_frames: npt.NDArray[np.int64]


   .. py:attribute:: emissions


   .. py:method:: plot(mode: Literal['on_histogram', 'off_histogram', 'on_frame_series', 'off_frame_series', 'on_boxplot', 'off_boxplot'] = 'off_histogram', **kwargs: Any) -> numpy.typing.NDArray[matplotlib.axes.Axes]

      Plot histogram, boxplot or frame series of ON or OFF periods.

      :param mode: One of 'on_histogram', 'off_histogram', 'on_frame_series',
                   'off_frame_series', 'on_boxplot', 'off_boxplot'.
      :type mode: str
      :param kwargs: fluopy.figure.universal_figure arguments

      :returns: Contains matplotlib.axes._subplots.AxesSubplots.
      :rtype: npt.NDArray[mplAxes]