Skip to content

io

sleap_io.io

This sub-package contains I/O-related modules such as specific format backends.

Modules:

Name Description
alphatracker

This module handles direct I/O operations for working with AlphaTracker files.

analysis_h5

SLEAP Analysis HDF5 format I/O.

cli

Command-line interface for sleap-io.

coco

Handles direct I/O operations for working with COCO-style datasets.

csv

CSV I/O for pose tracking data.

dlc

This module handles direct I/O operations for working with DeepLabCut (DLC) files.

geojson

GeoJSON I/O for ROIs.

jabs

This module handles direct I/O operations for working with JABS files.

labelstudio

This module handles direct I/O operations for working with Labelstudio files.

leap

This module handles direct I/O operations for working with LEAP .mat files.

main

This module contains high-level wrappers for utilizing different I/O backends.

nwb

Harmonization layer for NWB I/O operations.

nwb_annotations

NWB formatted annotations.

nwb_predictions

Functions to write and read from the neurodata without borders (NWB) format.

seq

Backend for reading Norpix .seq video files.

skeleton

This module handles I/O operations for standalone skeleton JSON files.

slp

This module handles direct I/O operations for working with .slp files.

slp_lazy

Lazy loading support for SLP files.

tiff

TIFF I/O for LabelImage data.

trackmate

Read TrackMate CSV exports into sleap-io data structures.

ultralytics

Handles direct I/O operations for working with Ultralytics YOLO formats.

utils

Miscellaneous utilities for working with different I/O formats.

video_reading

Backends for reading videos.

video_writing

Utilities for writing videos.

Attributes:

Name Type Description
__cached__

str(object='') -> str

__doc__

str(object='') -> str

__file__

str(object='') -> str

__name__

str(object='') -> str

__package__

str(object='') -> str

__path__

Built-in mutable sequence.

__cached__ = '/home/runner/work/sleap-io/sleap-io/sleap_io/io/__pycache__/__init__.cpython-313.pyc' module-attribute

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

__doc__ = 'This sub-package contains I/O-related modules such as specific format backends.' module-attribute

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

__file__ = '/home/runner/work/sleap-io/sleap-io/sleap_io/io/__init__.py' module-attribute

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

__name__ = 'sleap_io.io' module-attribute

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

__package__ = 'sleap_io.io' module-attribute

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

__path__ = ['/home/runner/work/sleap-io/sleap-io/sleap_io/io'] module-attribute

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.