allensdk.brain_observatory.ecephys.ecephys_session_api.ecephys_nwb_session_api module

class allensdk.brain_observatory.ecephys.ecephys_session_api.ecephys_nwb_session_api.EcephysNwbSessionApi(path, probe_lfp_paths: Dict[int, Callable[[], NWBFile]] | None = None, additional_unit_metrics=None, external_channel_columns=None, **kwargs)

Bases: NwbApi, EcephysSessionApi

get_channels() → DataFrame

get_current_source_density(probe_id)

get_ecephys_session_id() → int

get_lfp(probe_id: int) → DataArray

get_mean_waveforms() → Dict[int, ndarray]

get_metadata()

get_optogenetic_stimulation() → DataFrame

get_probes() → DataFrame

get_pupil_data() → DataFrame | None

get_raw_running_data()

get_rig_metadata() → dict | None

get_running_speed(include_rotation=False) → DataFrame

Gets the running speed Parameters ———- lowpass: bool

Whether to return the running speed with lowpass filter applied or without

Returns:

RunningSpeed:

The running speed

get_screen_gaze_data(include_filtered_data=False) → DataFrame | None

get_session_start_time()

get_spike_amplitudes() → Dict[int, ndarray]

get_spike_times() → Dict[int, ndarray]

get_stimulus_presentations()

get_units() → DataFrame

path

test()

A minimal test to make sure that this API’s NWB file exists and is readable. Ecephys NWB files use the required session identifier field to store the session id, so this is guaranteed to be present for any uncorrupted NWB file.

Of course, this does not ensure that the file as a whole is correct.