aind_ephys_utils.standards.conventions module

Naming conventions used by aind_ephys_utils.

This module centralizes canonical dimension names, coordinate names, and attribute keys used across the library.

Keeping conventions stable makes it easier to write composable analysis code.

class aind_ephys_utils.standards.conventions.Conventions(trial: str = 'trial', unit: str = 'unit', time: str = 'time', channel: str = 'channel', event: str = 'event', event_time_var: str = 't', spike_times_col: str = 'spike_times', trial_start_col: str = 'start_time', trial_end_col: str = 'end_time', attr_time_unit: str = 'ephys.time_unit', attr_timebase: str = 'ephys.timebase', attr_kind: str = 'ephys.kind', attr_history: str = 'ephys.history', attr_valid_intervals: str = 'ephys.valid_intervals', default_time_unit: str = 's')

Bases: object

Central place to define naming conventions. Make this stable and boring.

attr_history: str = 'ephys.history'

attr_kind: str = 'ephys.kind'

attr_time_unit: str = 'ephys.time_unit'

attr_timebase: str = 'ephys.timebase'

attr_valid_intervals: str = 'ephys.valid_intervals'

channel: str = 'channel'

default_time_unit: str = 's'

event: str = 'event'

event_time_var: str = 't'

spike_times_col: str = 'spike_times'

time: str = 'time'

trial: str = 'trial'

trial_end_col: str = 'end_time'

trial_start_col: str = 'start_time'

unit: str = 'unit'