Clustering

See also:

Format Specification or Source Specification for Clustering.

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

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

CLUSTERING - DEPRECATED Clustered spike data, whether from automatic clustering tools (e.g., klustakwik) or as a result of manual sorting.

Required Properties*:

description, num, peak_over_rms, times

Constructor Summary
Clustering(varargin)

CLUSTERING - Constructor for Clustering

Syntax:

clustering = types.core.CLUSTERING() creates a Clustering object with unset property values.

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

Input Arguments (Name-Value Arguments):

  • description (char) - Description of clusters or clustering, (e.g. cluster 0 is noise, clusters curated using Klusters, etc)

  • num (int32) - Cluster number of each event

  • peak_over_rms (single) - Maximum ratio of waveform peak to RMS on any channel in the cluster (provides a basic clustering metric).

  • times (double) - Times of clustered events, in seconds. This may be a link to times field in associated FeatureExtraction module.

Output Arguments:
Property Summary
description

REQUIRED (char) Description of clusters or clustering, (e.g. cluster 0 is noise, clusters curated using Klusters, etc)

num

REQUIRED (int32) Cluster number of each event

peak_over_rms

REQUIRED (single) Maximum ratio of waveform peak to RMS on any channel in the cluster (provides a basic clustering metric).

times

REQUIRED (double) Times of clustered events, in seconds. This may be a link to times field in associated FeatureExtraction module.

Tip

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