Skip to content

Conversation

@alejoe91
Copy link
Member

@alejoe91 alejoe91 commented Jan 7, 2026

Depends on #4316

Slices a sorting object based on an array ov valid periods. Periods are defined as a structured dtype as:

base_period_dtype = [
    ("start_sample_index", "int64"),
    ("end_sample_index", "int64"),
    ("segment_index", "int64"),
    ("unit_index", "int64"),
]

EDIT:

Refactored computation of spike train metrics, to make sure that periods are consistently taken into account. Added 2 utils functions to compute durations per unit and bin edges per unit, that optionally use the provided periods

@alejoe91 alejoe91 added the core Changes to core module label Jan 7, 2026
@alejoe91 alejoe91 mentioned this pull request Jan 7, 2026
1 task
@alejoe91 alejoe91 marked this pull request as ready for review January 8, 2026 07:36
@alejoe91 alejoe91 requested a review from chrishalcrow January 8, 2026 07:36
@samuelgarcia
Copy link
Member

This is OK for me.
Make a clear documentation somwhere woule help ?

rng = np.random.default_rng()

# number of random periods
n_periods = 10_000
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duration, num_units and n_periods are all quite large for a test. Is it slow??

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree we should put a small number

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

takes about 1 second

("unit_index", "int64"),
]

base_period_dtype = [
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move all dtypes to base

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done in #4314

@alejoe91
Copy link
Member Author

@chrishalcrow I refactored a few metrics to make sure durations, spike counts, and bins are properly accounted for when slicing with periods. Happy to discuss about this!

@alejoe91 alejoe91 changed the title Implement select_sorting_periods Implement select_sorting_periods in metrics Jan 13, 2026
@alejoe91 alejoe91 requested a review from yger January 15, 2026 15:13
Copy link
Collaborator

@yger yger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me, I think this is a great extension to be able to compute metrics on sub_periods only. A couple of minor comments, and I think everything is not too slow, but good work!


# Check that all spikes in the sliced sorting are within the periods
for segment_index in range(sorting.get_num_segments()):
periods_in_segment = periods[periods["segment_index"] == segment_index]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we assume not too many periods, just to be sure that all these masks won't take too long?

spike_vector = sorting.to_spike_vector()
spike_vector_list = sorting.to_spike_vector(concatenated=False)
keep_mask = np.zeros(len(spike_vector), dtype=bool)
all_global_indices = spike_vector_to_indices(spike_vector_list, unit_ids=sorting.unit_ids, absolute_index=True)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not using self.sorting_analyzer.sorting.get_spike_vector_to_indices(), and thus make use of a possible cache?

for segment_index in range(sorting.get_num_segments()):
global_indices_segment = all_global_indices[segment_index]
# filter periods by segment
periods_in_segment = periods[periods["segment_index"] == segment_index]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assuming not too many periods, these masks would be fine. Otherwise, we'll need to optimize

@yger
Copy link
Collaborator

yger commented Jan 15, 2026

We don't want to extend these quality metrics to the extension() ? What if someone wants to only get the ISI, CCG or anything else only on the periods? Would it be easy to slice the sorting, and then compute only on the sub sorting? Are the extension robust w.r.t. periods?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Changes to core module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants