deepof.annotation_utils.sniff_object

deepof.annotation_utils.sniff_object(speed_dframe: DataFrame, arena_type: str, arena: array, pos_dict: DataFrame, tol: float, tol_speed: float, nose: str, center_name: str = 'Center', centered_data: bool = False, s_object: str = 'arena', animal_id: str = '')

Return True if the specified mouse is sniffing an object.

Parameters:

• speed_dframe (pandas.DataFrame) – speed of body parts over time.

• arena_type (str) – arena type; must be one of [‘polygonal-manual’, ‘circular-autodetect’].

• arena (np.array) – contains arena location and shape details.

• pos_dict (table_dict) – position over time for all videos in a project.

• tol (float) – minimum tolerance to report a hit.

• center_name (str) – Body part to center coordinates on. “Center” by default.

• nose (str) – indicates the name of the body part representing the nose of the selected animal.

• centered_data (bool) – indicates whether the input data is centered.

• s_object (str) – indicates the object to sniff. Must be one of [‘arena’, ‘object’].

• animal_id (str) – indicates the animal to sniff. Must be one of animal_ids.

• tol_speed (float) – minimum speed to report a hit.

Returns:

boolean array. True if selected animal is sniffing the selected object

Return type:

sniffing (np.array)