Skip to main content

Represent acoustic stimuli and responses

Project description

PyPI

ndx-sound Extension for NWB

NWB extension for sounds.

Installation

pip install ndx-sound

Usage

Python

Add to an NWB file

from pynwb import NWBFile
from scipy.io import wavfile

from ndx_sound import AcousticWaveformSeries

# The file path to the audio file
file_path = "audio_data.wav"

# Read the audio file to get the rate of the recording and the waveform
sampling_rate, samples = wavfile.read(file_path)

# Create an AcousticWaveformSeries object with a given name and description
acoustic_waveform_series = AcousticWaveformSeries(
    name="acoustic_stimulus",
    data=samples,
    rate=sampling_rate,
    description="acoustic stimulus",
)

# Create an NWBFile object where this AcousticWaveformSeries can be added to
nwbfile = NWBFile(
    session_description=...,
    identifier=...,
    session_start_time=...,
)

# If a recording of behavior, add to acquisition
nwbfile.add_acquisition(acoustic_waveform_series)

# If a stimulus, add to stimulus
nwbfile.add_stimulus(acoustic_waveform_series)

Visualization

Static widgets

Use plot_sound to visualize the waveform series and the spectrogram. For longer recordings, specify the time_window argument for the start and end time of the recording to be shown.

from ndx_sound.widgets import plot_sound

plot_sound(nwbfile.stimulus["acoustic_stimulus"])

# Show only from 5 to 15 seconds
plot_sound(nwbfile.stimulus["acoustic_stimulus"], time_window=(5, 15))

Use acoustic_waveform_widget to include an Audio element that plays the sound.

from ndx_sound.widgets import acoustic_waveform_widget

acoustic_waveform_widget(nwbfile.stimulus["acoustic_stimulus"], time_window=(5, 15))

Interactive widgets

Use AcousticWaveformWidget to use a slider for interactively scrolling through the recording and a button for changing the duration of the sound that is being shown.

from ndx_sound.widgets import AcousticWaveformWidget

AcousticWaveformWidget(nwbfile.stimulus["acoustic_stimulus"])

nwbwidgets

Use load_widgets to load the interactive sound widget into nwb2widget.

from ndx_sound.widgets import load_widgets
from nwbwidgets import nwb2widget

load_widgets()

nwb2widget(nwbfile)

nwbwidgets and HDF5IO

When using nwb2widget with an NWB file that is read from disk, make sure to have load_widgets imported within the same Jupyter cell where your data is being loaded.

from pynwb import NWBHDF5IO
from ndx_sound.widgets import load_widgets
from nwbwidgets import nwb2widget

load_widgets()


io = NWBHDF5IO("audio.nwb", mode="r", load_namespaces=True)
nwbfile = io.read()
nwb2widget(nwbfile)

This extension was created using ndx-template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ndx_sound-0.2.2.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

ndx_sound-0.2.2-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file ndx_sound-0.2.2.tar.gz.

File metadata

  • Download URL: ndx_sound-0.2.2.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for ndx_sound-0.2.2.tar.gz
Algorithm Hash digest
SHA256 aaa74979487715c7b824eb95ce4c15ef7ee69a085e26618a62bd57ab75006a12
MD5 dccd570000ea0f4145950033a3b4b112
BLAKE2b-256 c9488922d7e541101c2215d9ed90e8f8af7bc31c2b2d3fdb1f3d0cf99d66d475

See more details on using hashes here.

File details

Details for the file ndx_sound-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: ndx_sound-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for ndx_sound-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cac4e412983a2354604cdc629b8f76821153551ff5879fa8ae36f573a8a4bee4
MD5 c9c56d72b36ed41f355412aecd300645
BLAKE2b-256 3d885b88c9f925e283bdf513cd80342757b65984f4c7ff76cf42b08b87cde901

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page