๐Ÿ“– API Reference๏ƒ

This section provides a categorized reference of SimBAโ€™s modules and methods, grouped by their functionality such as feature extraction, plotting, transformation, and modeling.

๐Ÿ” Blob tracking tools๏ƒ

Track animals in videos using background subtraction and blob detection. Extract geometric features (center, nose, tail, left/right points) from detected blob shapes without requiring pose-estimation data.

๐Ÿ“ฆ Bounding-box tools๏ƒ

Detect animal interactions via overlapping bounding boxes.

See tutorial: Cue-light tutorial

๐Ÿ” Circular transformations๏ƒ

Statistical operations for circular data like head direction. Wraparound-aware, multi-animal capable, and based on body-part derived base angles.

๐Ÿ”ง Config reader๏ƒ

Parse SimBA config files and access project-specific metadata.

๐Ÿ’ก Cue-light tools๏ƒ

Link animal behavior to cue-light on/off states.

See tutorial: Cue-light tutorial

๐Ÿ”ง Data processing tools๏ƒ

Transform classification, tracking, and image data.

๐Ÿ“ Feature extraction mixins๏ƒ

Core low-level feature methods used in SimBAโ€™s default extraction pipelines.

๐Ÿ“ Feature extraction wrappers๏ƒ

Pre-configured โ€œout-of-the-boxโ€ feature extraction modules for common pose-estimation schemas.

๐Ÿ“ Geometry transformations๏ƒ

Transform pose-estimated body-part coordinates into geometric shapes (bounding boxes, polygons, circles), and compute spatial relationships like distance and intersection.

๐Ÿ–ผ๏ธ Image transformations๏ƒ

Slice frames and extract visual information from tracking data; compare image features across time.

๐Ÿท๏ธ Labeling tools๏ƒ

SimBA tools for annotating behavioral events.

๐Ÿค– Model tools๏ƒ

Create, train, and manage behavior classifiers in SimBA.

โš ๏ธ Outlier correction๏ƒ

Heuristic-based filtering of body-part tracking outliers.

๐ŸŽจ Plotting and visualization tools๏ƒ

Visualize behavioral data and pose-tracking outputs.

๐Ÿ“ฆ Pose-estimation import tools๏ƒ

Parse, load, and process pose-estimation data from common formats.

๐Ÿ—บ๏ธ ROI tools๏ƒ

Define and analyze regions-of-interest (ROIs) in relation to tracking data.

๐Ÿ“Š Statistics transformations๏ƒ

Compute statistical features, drift, distances, and distribution comparisons in sliding or static time windows.

๐Ÿ“ฅ Third-party label appenders๏ƒ

Append labels from external annotation tools to pose-estimation outputs.

๐Ÿ• Time-series transformations๏ƒ

Analyze time-series complexity using sliding window methods.

๐Ÿ”ฎ Unsupervised learning๏ƒ

Clustering and dimensionality reduction methods for behavioral analysis.

๐Ÿ–ฅ๏ธ User Interface (UI) tools๏ƒ

SimBAโ€™s GUI components and window-based interaction logic.

โš™๏ธ Utilities๏ƒ

Helper methods for logging, CLI execution, argument checks, warnings, and I/O.

๐Ÿ“น Video processing tools๏ƒ

Video processing tools using OpenCV and FFmpeg.

๐Ÿ‘๏ธ YOLO Methods๏ƒ

Methods for training YOLO models, creating training and validation datasets, and converting behavioral neuroscience-specific datasets to YOLO datasets.

Uses the Ultralytics package.