API reference#

Base plot

PlotTsd

Visualization for 1-dimensional pynapple time series object (nap.Tsd)

PlotTsdFrame

Visualization of a multi-columns pynapple time series (nap.TsdFrame).

PlotTs

Visualization for pynapple timestamps object (nap.Ts) as vertical tick marks.

PlotTsGroup

Visualization for plotting multiple spike trains (nap.TsGroup) as a raster plot.

PlotTsdTensor

Visualization for 3-dimensional time series (nap.TsdTensor) displayed as movies.

PlotVideo

Visualization for rendering video files synchronized with a time series.

Custom controllers

SpanController

The class for horizontal time-panning

SpanYLockController

Horizontal time-panning with y-axis locked

GetController

The class for grabbing a single time point

Audio and Video Manipulation

Classes allowing random access to video and audio frames, with pynapple-like get syntax or by indexing.

AudioHandler

Handler for reading and decoding audio frames from a file.

VideoHandler

Random-access video reader with timestamp-aware seeking.

Pynaviz

base_plot

Simple plotting class for each pynapple object.

audiovideo

controller

The controller class.

events

Custom pygfx events.

interval_set

Handling of interval sets associated to base_plot classes.

plot_manager

Plot manager for TsGroup, TsdFrame, and IntervalSet visualizations.

utils

synchronization_rules

Available sync controller options.

Qt

Module including Qt widgets with selection, sorting and coloring by metadata functionalities.

mainwindow

widget_plot

Plotting class for each pynapple object using Qt Widget.

widget_menu

Action and context classes

widget_list_selection

tsdframe_selection

interval_sets_selection