allensdk.brain_observatory.behavior.data_objects.cell_specimens.events module

class allensdk.brain_observatory.behavior.data_objects.cell_specimens.events.Events[source]

Bases: DataObject, RoisMixin, DataFileReadableInterface, NwbReadableInterface, NwbWritableInterface

columns: events: np.array lambda: float noise_std: float cell_roi_id: int

classmethod from_data_file(events_file: EventDetectionFile, filter_scale_seconds: float = 0.06451612903225806, filter_n_time_steps: int = 20, frame_rate_hz: float | None = None) → Events[source]

Populate a DataObject from the data file

Returns:
DataObject:

An instantiated DataObject which has name and value properties

classmethod from_nwb(nwbfile: NWBFile, filter_scale_seconds: float = 0.06451612903225806, filter_n_time_steps: int = 20, frame_rate_hz: float | None = None) → Events[source]

Populate a DataObject from a pyNWB file object.

Parameters:
nwbfile:

The file object (NWBFile) of a pynwb dataset file.

Returns:
DataObject:

An instantiated DataObject which has name and value properties

to_nwb(nwbfile: NWBFile) → NWBFile[source]

Given an already populated DataObject, return an pyNWB file object that had had DataObject data added.

Parameters:
nwbfileNWBFile

An NWB file object

Returns:
NWBFile

An NWB file object that has had data from the DataObject added to it.