ovrlpy.pre_process_coordinates
==============================

.. py:function:: ovrlpy.pre_process_coordinates(coordinate_df, grid_size = 1, coordinates = ('x', 'y', 'z'), use_message_passing = True, measure = 'mean', inplace = True, **kwargs)

   Runs the pre-processing routine of the coordinate dataframe.

   It assigns x,y coordinate pixels to all molecules in the data frame and determines a z-coordinate-center for each pixel.

   :param coordinate_df: A dataframe of coordinates.
   :type coordinate_df: pandas.DataFrame
   :param grid_size: The size of the pixel grid. Defaults to 1.
   :type grid_size: int, optional
   :param coordinates: Name of the coordinate columns.
   :type coordinates: tuple[str, str, str], optional
   :param use_message_passing: Whether to use message passing to determine the z-dimension delimiter. Defaults to True.
   :type use_message_passing: bool, optional
   :param measure: The measure to use to determine the z-dimension delimiter. Defaults to 'mean'. Other option is 'median'.
   :type measure: str, optional
   :param inplace: Whether to modify the input dataframe or return a copy. Defaults to True.
   :type inplace: bool, optional

   :returns: A dataframe with added x_pixel, y_pixel and z_delim columns.
   :rtype: pandas.DataFrame