User Api

Sonify Class

Sonify(data[, smap, envelope, fs])	Class for performing Data Sonification.
Sonify.to_waveform([wave, note_length])	Converts a normalized data variable into a waveform.
Sonify.to_audio([wave, note_length])	Returns an interactive Audio object for use in Notebooks
Sonify.to_notes()	Each data point represented as a Musical Note computed using the stored SoundMap
Sonify.to_frequencies()	Each data point represented as a frequency (hz) computed using the stored SoundMap
Sonify.plot([x, xlabel, title, figsize, ...])	Plots each data point in terms of its Musical Note representation

Sonify Accessor

SonifyAccessor(obj)	Accessor to support Data Sonification when linked to another data store object (i.e. Xarray DataArray, Pandas Series).
SonifyAccessor.plot([x, xlabel, title, ...])	Plots each data point in terms of its Musical Note representation

Soundmaps

scisonify.core.soundmaps.SoundMap()	Base class for a SoundMap
scisonify.core.soundmaps.DiscreteNoteBins(notes)	Maps normalized data points to a discrete set of musical notes.

Waveforms

scisonify.core.waveforms.sine_wave(freq, ...)	Sine Wave Waveform
scisonify.core.waveforms.square_wave(freq, ...)	Square Wave Waveform
scisonify.core.waveforms.sawtooth_wave(freq, ...)	Sawtooth Wave Waveform

Envelopes

scisonify.core.envelope.EnvelopeADSR([...])

Attack-Decay-Sustain-Release Envelope Implementation, adapted from the C++ implementation by javidx9 (https://www.youtube.com/watch?v=OSCzKOqtgcA)