ClusterWaveforms

See also:

Format Specification or Source Specification for ClusterWaveforms.

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

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

CLUSTERWAVEFORMS - DEPRECATED The mean waveform shape, including standard deviation, of the different clusters. Ideally, the waveform analysis should be performed on data that is only high-pass filtered. This is a separate module because it is expected to require updating. For example, IMEC probes may require different storage requirements to store/display mean waveforms, requiring a new interface or an extension of this one.

Required Properties*:

clustering_interface, waveform_filtering, waveform_mean, waveform_sd

Constructor Summary
ClusterWaveforms(varargin)

CLUSTERWAVEFORMS - Constructor for ClusterWaveforms

Syntax:

clusterWaveforms = types.core.CLUSTERWAVEFORMS() creates a ClusterWaveforms object with unset property values.

clusterWaveforms = types.core.CLUSTERWAVEFORMS(Name, Value) creates a ClusterWaveforms object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • clustering_interface (Clustering) - Link to Clustering interface that was the source of the clustered data

  • waveform_filtering (char) - Filtering applied to data before generating mean/sd

  • waveform_mean (single) - The mean waveform for each cluster, using the same indices for each wave as cluster numbers in the associated Clustering module (i.e, cluster 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should be empty (e.g., zero- filled)

  • waveform_sd (single) - Stdev of waveforms for each cluster, using the same indices as in mean

Output Arguments:
Property Summary
clustering_interface

REQUIRED (Clustering) Link to Clustering interface that was the source of the clustered data

waveform_filtering

REQUIRED (char) Filtering applied to data before generating mean/sd

waveform_mean

REQUIRED (single) The mean waveform for each cluster, using the same indices for each wave as cluster numbers in the associated Clustering module (i.e, cluster 3 is in array slot [3]). Waveforms corresponding to gaps in cluster sequence should be empty (e.g., zero- filled)

waveform_sd

REQUIRED (single) Stdev of waveforms for each cluster, using the same indices as in mean

Tip

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