API reference

Core objects

Time Series

Tsd	1-dimensional container for neurophysiological time series.
TsdFrame	Column-based container for neurophysiological time series.
TsdTensor	Container for neurophysiological time series with more than 2 dimensions (for example movies).

Intervals

IntervalSet

A class representing a (irregular) set of time intervals in elapsed time, with relative operations

Timestamps

Ts	Timestamps only object for a time series with only time index.

Group of timestamps

TsGroup

Dictionary-like object to group objects with different timestamps (for example timestamps of spikes of a population of neurons).

Input-Ouput

Neurodata Without Borders (NWB)

NWBFile

Class for reading NWB Files.

Numpy files

NPZFile

Class to read/write NPZ files as a pynapple object.

Miscellaneous

misc	Various io functions
folder.Folder	Dictionnary like object to walk and loop through nested folders.

Analysis modules

correlograms	Functions to compute correlograms of timestamps data.
decoding	Functions to decode n-dimensional features.
filtering	Functions for highpass, lowpass, bandpass or bandstop filtering.
perievent	Functions to realign time series relative to a reference time.
randomize	Functions to shuffle timestamps to create surrogate datasets.
spectrum	Functions to compute power spectral density and mean power spectral density.
tuning_curves	Functions to compute n-dimensional tuning curves.
wavelets	Functions to compute wavelets decomposition of a time series.
warping	Functions to create trial-based tensors and warp times