torch_brain.data#

Core data structures for representing neural and behavioral data.

See The Data Format for further details.

Core Objects#

ArrayDict

A dictionary of arrays that share the same first dimension.

Data

A flexible container for other data objects such as ArrayDict, RegularTimeSeries, IrregularTimeSeries, and Interval objects, as well as nested Data objects and regular Python objects like scalars, strings, and numpy arrays.

Interval

An interval object is a set of time intervals each defined by a start time and an end time.

IrregularTimeSeries

An irregular time series is defined by a set of timestamps and a set of attributes that must share the same first dimension as the timestamps.

RegularTimeSeries

A regular time series is the same as an irregular time series, but it has a regular sampling rate.

Lazy Variants#

Description Containers#

BrainsetDescription

A container for storing brainset metadata.

DeviceDescription

A container for storing recording device metadata.

SessionDescription

A container to store experimental session related metadata.

SubjectDescription

A container for storing subject related metadata.

Utility Functions#

concat

Concatenates multiple time series objects into a single object.

get_default_serialize_fn_map

Returns the default serialization map used when saving Data to HDF5.