← Back to API reference

neuralset.events.etypes.Spikes

pydantic model neuralset.events.etypes.Spikes

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

Fields:

• subject (Annotated[str, pydantic.functional_validators.BeforeValidator(func=neuralset.base._int_cast, json_schema_input_type=PydanticUndefined)])

field subject: Annotated[str, BeforeValidator(func=_int_cast, json_schema_input_type=PydanticUndefined)] = ''

requirements: tp.ClassVar[tuple[str, ...]] = ()

type: tp.ClassVar[str] = 'Spikes'

← Back to API reference