Amplitude median (amplitude_median
)¶
Calculation¶
Geometric median amplitude is computed in the log domain. The metric is then converted back to original units.
Expectation and use¶
A larger value (larger signal) is taken to indicate a better unit.
Example code¶
import spikeinterface.qualitymetrics as qm
# It is also recommended to run `compute_spike_amplitudes(wvf_extractor)`
# in order to use amplitude values from all spikes.
amplitude_medians = qm.compute_amplitude_medians(wvf_extractor)
# amplitude_medians is a dict containing the units' ID as keys,
# and their estimated amplitude medians as values.
Reference¶
- spikeinterface.qualitymetrics.misc_metrics.compute_amplitude_medians(waveform_extractor, peak_sign='neg')¶
Compute median of the amplitude distributions (in absolute value).
- Parameters
- waveform_extractorWaveformExtractor
The waveform extractor object.
- peak_sign{‘neg’, ‘pos’, ‘both’}
The sign of the peaks.
- Returns
- all_amplitude_mediansdict
Estimated amplitude median for each unit ID.
References
Inspired by metric described in [IBL] This code is ported from: https://github.com/int-brain-lab/ibllib/blob/master/brainbox/metrics/single_units.py
Links to original implementations¶
From IBL
Literature¶
Introduced by [IBL].