Package index
Reading any file
One entry point for every supported format. read_dataset() works out which source software wrote a file and reads it, so you do not need to know which reader it needs beforehand.
-
read_dataset() - Read a movement or event dataset from any supported format
-
detect_source() - Detect which source software wrote a file
Reader functions
The format-specific readers read_dataset() dispatches to. Call them directly when you already know the source, or for their format-specific arguments.
-
read_aniframe() - Read an aniframe from a Parquet file
-
read_animalta() - Read AnimalTA data
-
read_anipose() - Read Anipose 3D pose estimation data
-
read_bonsai() - Read centroid tracking data from Bonsai
-
read_c3d() - Read a C3D motion capture file
-
read_custom() - Read a custom file format
-
read_deeplabcut() - Read DeepLabCut data
-
read_fasttrack() - Read FastTrack tracking data
-
read_fictrac() - Read projected FicTrac data
-
read_freemocap() - Read FreeMoCap motion capture data
-
read_idtracker() - Read idtracker.ai data
-
read_lightningpose() - Read LightningPose data
-
read_movement() - Read data exported from the movement Python package
-
read_octron() - Read Octron Segmentation Data
-
read_sleap() - Read SLEAP data
-
read_trackball() - Read trackball data
-
read_trackmate() - Read TrackMate XML into an aniframe
-
read_trex() - Read TRex Movement Tracking Data
-
read_boris() - Read events from a BORIS export
-
write_aniframe() - Write an aniframe to disk
-
write_intracktive() - Write aniframe data to inTRACKtive CSV format
-
get_supported_sources() - List the source software formats aniread can read
-
get_sample_data() - Download sample tracking data
-
calibrate_trackball() - Get calibration values for trackball data