example_unit_metrics_graph.py

# 8/31/22
# https://figurl.org/f?v=gs://figurl/spikesortingview-8&d=sha1://e62bd047d382fe031717714423110c182db1c0ff&label=Unit%20metrics%20graph%20example

from typing import List
import sortingview.views as vv
import spikeinterface as si
import spikeinterface.extractors as se
import kachery as ka
from helpers.create_units_table import create_units_table


def main():
    ka.use_sandbox()
    recording, sorting = se.toy_example(num_units=12, duration=300, seed=0, num_segments=1)
    assert isinstance(recording, si.BaseRecording)

    view = example_unit_metrics_graph(recording=recording, sorting=sorting)

    view2 = vv.Box(direction="horizontal", items=[vv.LayoutItem(create_units_table(sorting=sorting), max_size=150), vv.LayoutItem(view)])

    url = view2.url(label="Unit metrics graph example")
    print(url)


def example_unit_metrics_graph(*, recording: si.BaseRecording, sorting: si.BaseSorting, height=800):
    metrics: List[vv.UnitMetricsGraphMetric] = [
        vv.UnitMetricsGraphMetric(key="numEvents", label="Num. events", dtype="int"),
        vv.UnitMetricsGraphMetric(key="firingRateHz", label="Firing rate (Hz)", dtype="float"),
    ]
    units: List[vv.UnitMetricsGraphUnit] = []
    for unit_id in sorting.get_unit_ids():
        spike_train = sorting.get_unit_spike_train(segment_index=0, unit_id=unit_id)
        units.append(
            vv.UnitMetricsGraphUnit(
                unit_id=unit_id,
                values={"numEvents": len(spike_train), "firingRateHz": len(spike_train) / (recording.get_num_frames(segment_index=0) / recording.get_sampling_frequency())},
            )
        )
    view = vv.UnitMetricsGraph(units=units, metrics=metrics, height=height)
    return view


if __name__ == "__main__":
    main()