deepof.annotation_utils.close_single_contact

deepof.annotation_utils.close_single_contact(pos_dframe: DataFrame, left: str, right: str, tol: float, arena_abs: int, arena_rel: int) → array

Return a boolean array that’s True if the specified body parts are closer than tol.

Parameters:

• pos_dframe (pandas.DataFrame) – DLC output as pandas.DataFrame; only applicable to two-animal experiments.

• left (string) – First member of the potential contact

• right (string) – Second member of the potential contact

• tol (float) – maximum distance for which a contact is reported

• arena_abs (int) – length in mm of the diameter of the real arena

• arena_rel (int) – length in pixels of the diameter of the arena in the video

Returns:

True if the distance between the two specified points is less than tol, False otherwise

Return type:

contact_array (np.array)