EventDetection

See also:

Format Specification or Source Specification for EventDetection.

class types.core.EventDetection(varargin)[source]

Bases: types.core.NWBDataInterface, types.untyped.GroupClass

EVENTDETECTION - Detected spike events from voltage trace(s).

Required Properties*:

detection_method, source_electricalseries, source_idx

Constructor Summary
EventDetection(varargin)

EVENTDETECTION - Constructor for EventDetection

Syntax:

eventDetection = types.core.EVENTDETECTION() creates an EventDetection object with unset property values.

eventDetection = types.core.EVENTDETECTION(Name, Value) creates an EventDetection object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • detection_method (char) - Description of how events were detected, such as voltage threshold, or dV/dT threshold, as well as relevant values.

  • source_electricalseries (ElectricalSeries) - Link to the ElectricalSeries that this data was calculated from. Metadata about electrodes and their position can be read from that ElectricalSeries so it’s not necessary to include that information here.

  • source_idx (int32) - Indices (zero-based) into the linked source ElectricalSeries::data array corresponding to time of event or time and channel of event. ‘’description’’ should define what is meant by time of event (e.g., .25 ms before action potential peak, zero-crossing time, etc). The index points to each event from the raw data.

  • times (double) - DEPRECATED. Timestamps of events, in seconds.

Output Arguments:
Property Summary
detection_method

REQUIRED (char) Description of how events were detected, such as voltage threshold, or dV/dT threshold, as well as relevant values.

source_electricalseries

REQUIRED (ElectricalSeries) Link to the ElectricalSeries that this data was calculated from. Metadata about electrodes and their position can be read from that ElectricalSeries so it’s not necessary to include that information here.

source_idx

REQUIRED (int32) Indices (zero-based) into the linked source ElectricalSeries::data array corresponding to time of event or time and channel of event. ‘’description’’ should define what is meant by time of event (e.g., .25 ms before action potential peak, zero-crossing time, etc). The index points to each event from the raw data.

times

(double) DEPRECATED. Timestamps of events, in seconds.

times_unit = "seconds"

(char) Unit of measurement for event times, which is fixed to ‘seconds’.

Tip

* If a required property link is not functional, the property may be defined in a superclass. Please refer to the superclass documentation.