features.ModelSpikeShapeFeatures

features.ModelSpikeShapeFeatures()

Schema for the sparse, neuroscientist-facing spike-shape feature set.

Output of remap_waveform_shape_features. Adds the reparametrised columns to ModelSpikeSharedFeatures‘s unchanged pass-through fields. Note this schema’s ’peak’ is the negative deflection and ‘trough’ the positive rebound after it, opposite common neurophysiology usage, so spike_width_secs is the classic trough-to-peak width despite the name order.

The 3 inherited slope columns correlate strongly with the amplitude/duration columns below (r=0.96-0.99 with algebraic reconstructions from them) and add no real extra information, but are kept precomputed anyway since they’re a commonly-used, handy quantity on their own.

Attributes: spike_width_secs (Series[float]): Trough-to-peak spike duration (s). predepolarisation_width_secs (Series[float]): Tip-to-peak duration (s). spike_amplitude (Series[float]): Trough-to-peak amplitude (V). peak_to_trough_ratio_log (Series[float]): Log amplitude ratio (dimensionless).