LoaderProtocol#

class movement.io.load.LoaderProtocol(*args, **kwargs)[source]#

Bases: Protocol

Protocol for loader functions to be registered via register_loader.

All loader functions registered via register_loader() must conform to this protocol. Loaders must accept a file path (str or Path) or pynwb.file.NWBFile object) as their first argument and return an xarray.Dataset containing pose tracks or bounding box tracks. Additional positional and keyword arguments are allowed.

See also

register_loader

Decorator for registering loader functions.