:py:mod:`tonic.functional.denoise`
==================================

.. py:module:: tonic.functional.denoise


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


Functions
~~~~~~~~~

.. autoapisummary::

   tonic.functional.denoise.denoise_numpy



.. py:function:: denoise_numpy(events, filter_time=10000)

   Drops events that are 'not sufficiently connected to other events in the recording.' In
   practise that means that an event is dropped if no other event occured within a spatial
   neighbourhood of 1 pixel and a temporal neighbourhood of filter_time time units. Useful to
   filter noisy recordings where events occur isolated in time.

   :param events: ndarray of shape [num_events, num_event_channels]
   :param filter_time: maximum temporal distance to next event, otherwise dropped.
                       Lower values will mean higher constraints, therefore less events.

   :returns: filtered set of events.