API 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

idtracker.ai tools, which have a dedicated command line main entrypoint, can also be called from here as Python functions.