ovrlpy.process_coordinates
==========================

.. py:function:: ovrlpy.process_coordinates(coordinates, /, gridsize = 1, *, coordinate_keys = ('x', 'y', 'z'), method = 'message_passing', shift = True, n_iter = 20, dtype = Float32)

   Runs the pre-processing routine of the coordinate dataframe.

   x,y coordinates are rescaled by the gridsize and x,y pixels assigned to all
   molecules. A z-coordinate-center for each pixel is calculated.

   :param coordinates: A dataframe of coordinates.
   :type coordinates: polars.DataFrame
   :param gridsize: The size of the pixel grid.
   :type gridsize: float, optional
   :param coordinate_keys: Name of the coordinate columns.
   :type coordinate_keys: tuple[str, str, str], optional
   :param method: The measure to use to determine the z-dimension threshold for subslicing.
                  One of, mean, median, and message_passing.
   :type method: bool, optional
   :param shift: Whether to shift the x,y coordinates to 0 to minimize the analysis area.
                 If False, the sample will keep its original shape.
   :type shift: bool
   :param n_iter: Number of iterations. Only used if the method is message_passing.
   :type n_iter: int, optional
   :param dtype: Datatype of the z-coordinate center.
   :type dtype: type[polars.DataType], optional

   :returns: A dataframe with added x_pixel, y_pixel, and z_center column.
   :rtype: polars.DataFrame