API Reference#

This guide provides documentation for all modules, function, methods, and classes within tobac for those in the public API.

Documentation is broken down by directory and module.

feature_detection

First step toward working with tobac.

tracking

Provide tracking methods.

segmentation

merge_split

Tobac merge and split This submodule is a post processing step to address tracked cells which merge/split.

utils.bulk_statistics

Support functions to compute bulk statistics of features, either as a postprocessing step or within feature detection or segmentation.

utils.general

General tobac utilities

plotting

Provide methods for plotting analyzed data.

analysis.cell_analysis

Perform analysis on the properties of tracked cells

analysis.feature_analysis

Perform analysis on the properties of detected features

analysis.spatial

Calculate spatial properties (distances, velocities, areas, volumes) of tracked objects