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) indicates a better unit.
Example code¶
import spikeinterface.qualitymetrics as sqm
# It is also recommended to run sorting_analyzer.compute(input="spike_amplitudes")
# in order to use amplitude values from all spikes.
amplitude_medians = sqm.compute_amplitude_medians(sorting_analyzer)
# amplitude_medians is a dict containing the unit IDs as keys,
# and their estimated amplitude medians as values.
Reference¶
- spikeinterface.qualitymetrics.misc_metrics.compute_amplitude_medians(sorting_analyzer, peak_sign='neg', unit_ids=None)¶
Compute median of the amplitude distributions (in absolute value).
- Parameters
- sorting_analyzer: SortingAnalyzer
A SortingAnalyzer object
- peak_sign“neg” | “pos” | “both”, default: “neg”
The sign of the peaks.
- unit_idslist or None
List of unit ids to compute the amplitude medians. If None, all units are used.
- 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].