Code reference#

This documentation is not finished, we are working in it…

Main classes#

Session

A class containing the main features of the session.

Blob

Represents a segmented animal(s) defined with a contour in a specific frame.

ListOfBlobs

Contains all the instances of the class Blob.

Fragment

A collection of Blob s that belong to the same animal or to the same crossing.

ListOfFragments

Contains all the instances of the class Fragment.

GlobalFragment

Represents a collection of N_animals coexisting Fragment s.

ListOfGlobalFragments

Contains all the instances of the class GlobalFragment.

API to Extra tools#

extra_tools.validator

Module to validate the tracking data of a session, see Validator.

extra_tools.idmatcherai

idmatcher.ai matches identities from two different tracked sessions, see idmatcher.ai.

extra_tools.video_generator

The video generator tool is used to generate videos from the tracking data generated by the idtracker.ai software, see Video Generator.

extra_tools.cluster_inspection

A simple module to inspect contrastive clusters after tracking, see Cluster inspection.

idtracker.ai modules#

base.tracker.contrastive

Contrastive Learning module