agepy.mag.trajectory.get_vmax

get_vmax(df, periods=1, dim_col='x')

Calculates the absolute mean maximum velocity of the particles.

Takes the dataframe of particles, calculates diff for given dimension, then maximum absolute value for each particle in this df. Finally returns the mean of all these particles.

Parameters:

df: DataFrame

with particle data (from trackpy)

periods: int, optional

Window of frames to get diff/velocity from. Default is 1.

dim_col: string, optional

Calculate velocity on column x or y. Default is “x”.

Returns:

vmax:

The mean absolute maximum velocity of each particle.

Return type:

float