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: Optional[Dict[int, Callable[[], pynwb.file.NWBFile]]] = None, additional_unit_metrics=None, external_channel_columns=None, **kwargs)[source]

Bases: allensdk.brain_observatory.nwb.nwb_api.NwbApi, allensdk.brain_observatory.ecephys.ecephys_session_api.ecephys_session_api.EcephysSessionApi

get_channels(self) → pandas.core.frame.DataFrame[source]
get_current_source_density(self, probe_id)[source]
get_ecephys_session_id(self) → int[source]
get_lfp(self, probe_id: int) → xarray.core.dataarray.DataArray[source]
get_mean_waveforms(self) → Dict[int, numpy.ndarray][source]
get_metadata(self)[source]
get_optogenetic_stimulation(self) → pandas.core.frame.DataFrame[source]
get_probes(self) → pandas.core.frame.DataFrame[source]
get_pupil_data(self, suppress_pupil_data: bool = True) → Union[pandas.core.frame.DataFrame, NoneType][source]
get_raw_running_data(self)[source]
get_rig_metadata(self) → Union[dict, NoneType][source]
get_running_speed(self, include_rotation=False)[source]
get_session_start_time(self)[source]
get_spike_amplitudes(self) → Dict[int, numpy.ndarray][source]
get_spike_times(self) → Dict[int, numpy.ndarray][source]
get_stimulus_presentations(self)[source]
get_units(self) → pandas.core.frame.DataFrame[source]
test(self)[source]

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.

allensdk.brain_observatory.ecephys.ecephys_session_api.ecephys_nwb_session_api.clobbering_merge(to_df, from_df, **kwargs)[source]