convnwb.sorting.utils.get_sorting_kept_labels

convnwb.sorting.utils.get_sorting_kept_labels(groups)[source]

Get the valid clas / group information from the combinato organized groups info array.

Parameters:
group2d array

Combinato organized array of class and group information. 1st column: class index / label; 2nd column: group assignment.

Returns:
valid_classes1d array

An array of the class assignments that reflect valid (to-be-kept) spikes.

valid_groups1d array

An array of the group assignments that reflect valid (to-be-kept) spikes.

Notes

In Combinato, there are two special cases of groups we want to avoid: - ‘0’: contains unassigned events (failed to be put in a class during clustering) - ‘-1’: classes that are assigned to the artifacts group

To get information about class labels that contain valid spikes (that we want to keep / extract), this function excludes 0 and -1 group labels.