universal_pd¶

data_base.analyze.spatiotemporal_binning.universal_pd(df, distance_column, spatial_distance_bins=50, min_time=0, max_time=300, time_distance_bins=1)¶

Bin a pandas DataFrame by both distance and time.

This is a speed-optimized binning code for 2d-binning of a pandas.DataFrame.

Parameters:¶

df : pandas.DataFrame¶

DataFrame to bin. Must contain a column with the name distance_column that contains the distance values.

distance_column : str¶

Column name of the distance values.

spatial_distance_bins : int¶

Size of the distance bins. Default is \(50\mu m\).

min_time : int¶

Minimum time value. Default is \(0 ms\).

max_time : int¶

Maximum time value. Default is \(300 ms\).

time_distance_bins : int¶

Size of the time bins. Default is \(1 ms\).

Returns:¶

A 2D array of the binned values.

Return type:¶

array