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

.. py:module:: tonic.functional.spatial_jitter


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


Functions
~~~~~~~~~

.. autoapisummary::

   tonic.functional.spatial_jitter.spatial_jitter_numpy



.. py:function:: spatial_jitter_numpy(events: numpy.ndarray, sensor_size: List[int], var_x: float = 1, var_y: float = 1, sigma_xy: float = 0, clip_outliers: bool = False)

   Changes x/y coordinate for each event by adding samples from a multivariate Gaussian
   distribution. It with the following properties:

       .. math::
           mean = [x,y]

           \Sigma = [[var_x, sigma_{xy}],[sigma_{xy}, var_y]]

   Jittered events that lie outside the focal plane will be dropped if clip_outliers is True.

   :param events: ndarray of shape [num_events, num_event_channels]
   :param var_x: squared sigma value for the distribution in the x direction
   :param var_y: squared sigma value for the distribution in the y direction
   :param sigma_xy: changes skewness of distribution, only change if you want shifts along diagonal axis.
   :param clip_outliers: when True, events that have been jittered outside the sensor size will be dropped.

   :returns: array of spatially jittered events.