deepof.annotation_utils.huddle

deepof.annotation_utils.huddle(X_huddle: ndarray, huddle_estimator: Pipeline, animal_id: str = '') → array

Return true when the mouse is huddling a pretrained model.

Parameters:

• X_huddle (pandas.DataFrame) – mouse features over time.

• huddle_estimator (sklearn.pipeline.Pipeline) – pre-trained model to predict feature occurrence.

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

Returns:

1 if the animal is huddling, 0 otherwise

Return type:

y_huddle (np.array)