neuralset.events.etypes.Spikes¶

class neuralset.events.etypes.Spikes(*, start: float, timeline: str, duration: Annotated[float, Ge(ge=0)] = 0.0, extra: dict[str, Any] = {}, filepath: Path | str = '', frequency: float = 0, subject: Annotated[str, BeforeValidator(func=_int_cast, json_schema_input_type=PydanticUndefined)] = '')[source][source]¶

Spikes recording event saved as HDF5 object.

Base class for spikes recordings that can be loaded using HDF5.

Parameters:

subject (str) – Subject identifier (required, cannot be empty)
filepath (str) – Path to the HDF5 file (required, cannot be empty)

Notes

Subject ID is cast to string to handle numeric IDs from dataframes

Examples

spikes = Spikes(start=0, timeline="scan1", filepath="data_raw.nwb",
         subject="sub-01")
h5py_file = spikes.read()  # Returns h5py.File object