API Reference#

Look through specific module or search through the entire list of APIs.

All APIs

Object

Description

OpenNeuroDataset

Base class for OpenNeuro datasets.

PerichMillerPopulation2018

Motor cortex (M1 and PMd) spiking activity and reaching kinematics from four macaques

PeiPandarinathNLB2021

Curated spiking neural activity datasets from the Neural Latents Benchmark

FlintSlutzkyAccurate2012

Motor cortex (M1) spiking activity and reaching kinematics from 1 monkey

ChurchlandShenoyNeural2012

Motor cortex (M1 and PMd) spiking activity and reaching kinematics from 2 monkeys

OdohertySabesNonhuman2017

Motor cortex (M1 and S1) spiking activity and reaching kinematics from 2 monkeys

VollanMoserAlternating2025

Neuropixels recordings from MEC and hippocampus in rats during spatial navigation

ShiraziHBNR1DS005505

Shirazi HBN Resting State 1 (HBN-R1) iEEG Dataset (OpenNeuro DS005505).

AllenVisualCodingOphys2016

Two-photon calcium imaging of mouse visual cortex from the Allen Brain

Neuroprobe2025

Neuroprobe 2025 iEEG benchmark dataset.

KochiVisualNamingDS006914

Kochi Visual Naming iEEG Dataset (OpenNeuro DS006914).

KlinzingSleepDS005555

Klinzing Sleep iEEG Dataset (OpenNeuro DS005555).

KempSleepEDF2013

Sleep-EDF Database Expanded containing 197 whole-night polysomnographic sleep recordings.

BrainsetDescription

A container for storing brainset metadata.

SubjectDescription

A container for storing subject related metadata.

SessionDescription

A container to store experimental session related metadata.

DeviceDescription

A container for storing recording device metadata.

BrainsetPipeline

Abstract base class for defining processing pipelines.

calculate_sampling_rate

Calculates median sampling rate from an array of timestamps.

extract_subject_from_nwb

extract_spikes_from_nwbfile

Extract spikes and unit metadata from an NWBFile

download_file

Download a file from DANDI

get_nwb_asset_list

Get a list of all remote NWB assets in the given dandiset

fetch_eeg_recordings

Discover all EEG recordings inside a BIDS dataset or list of files.

fetch_ieeg_recordings

Discover all iEEG recordings inside a BIDS dataset or list of files.

group_recordings_by_entity

Group BIDS-compliant recordings by specified fixed entities.

check_eeg_recording_files_exist

Check if EEG data files corresponding to a BIDS recording_id exist in the BIDS root directory.

check_ieeg_recording_files_exist

Check if iEEG data files corresponding to a BIDS recording_id exist in the BIDS root directory.

build_bids_path

Build a mne_bids.BIDSPath for a given recording_id, modality, and BIDS root directory.

load_json_sidecar

Load the JSON sidecar file for a given BIDS file.

load_participants_tsv

Load participants.tsv data from a BIDS root directory.

get_subject_info

Retrieve demographic information (age, sex) for a given subject from a participants DataFrame.

extract_measurement_date

Extract the measurement date from MNE Raw recording data.

concatenate_recordings

Concatenate a list of MNE Raw objects into one, validating metadata.

extract_signal

Extract entire time-series signal from an MNE Raw object.

extract_channels

Extract channel metadata from an MNE Raw object, with support for custom channel name, type, and position mappings.

get_cached_s3_client

Get a cached S3 client configured for anonymous access to public buckets.

get_object_list

List all object keys under a prefix (excludes directories).

download_prefix

Download all files matching a prefix pattern.

download_prefix_from_url

Download all files matching an S3 URL prefix pattern.

generate_stratified_folds

Generates stratified train/valid/test splits using a two-stage splitting process.

generate_string_kfold_assignment

Generate deterministic per-fold train/valid/test assignments for one ID.

OPENNEURO_S3_BUCKET

str(object=’’) -> str

construct_s3_url_from_path

Construct an S3 URL prefix for a recording.

download_dataset_description

Download dataset_description.json from OpenNeuro S3.

download_recording

Download all files matching an S3 prefix pattern for a recording.

fetch_latest_snapshot_tag

Fetch the latest snapshot tag for an OpenNeuro dataset.

fetch_all_filenames

Fetch all filenames for a given OpenNeuro dataset using AWS S3.

fetch_participants_tsv

Fetch and parse participants.tsv from OpenNeuro S3.

fetch_species

Fetch species metadata for an OpenNeuro dataset from GraphQL.

OpenNeuroPipeline

Abstract base class for OpenNeuro dataset pipelines.

OpenNeuroDataModality

base_openneuro_parser

Object for parsing command line strings into Python objects.

downsample_wideband

Downsample wideband signal to LFP sampling rate.

extract_bands

Extract bands from LFP

cube_to_long

Convert a cube of threshold crossings to a list of trials and units.

datetime_serialize_fn

Convert a datetime object to a string.

serialize_fn_map

dict() -> new empty dictionary