API reference#
Organized by module group. Each page has full signatures with type hints, examples, and cross-links to the user guide.
At a glance
- TrialTree
The
TrialTreedata structure,open(),from_datasets(), trial access, iteration, filtering, and saving.- Dataset
Xarray-side dataset builders:
dataset_to_basic_trialtree(),downsample_trialtree(),add_changepoints_to_ds(),add_angle_rgb_to_ds().- Pynapple IO
Pynapple loaders and augmenters:
load_nap_data(),detect_trials(),add_changepoints_to_nap(),add_angle_rgb_to_nap(), plus NWB-import probes.- NWB alignment
NWBAlignment,align_media_per_trial(),align_media_from_streams().- Labels
Interval operations, TSV storage, dense ↔ interval conversion, predictions, Crowsetta/pynapple converters, export, and plotting.
- Changepoints
Detection (
find_peaks_binary(),find_troughs_binary(),find_nearest_turning_points_binary()), merging/time extraction, label correction, and the binary / smooth Laplacian / segment-IDmore_changepoint_features()used by downstream segmentation models.- xr_utils