allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.imaging_plane module

class allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.imaging_plane.ImagingPlane(ophys_frame_rate: float, targeted_structure: str, excitation_lambda: float, indicator: str | None)[source]

Bases: DataObject, LimsReadableInterface, JsonReadableInterface, NwbReadableInterface

property excitation_lambda: float
classmethod from_json(dict_repr: dict, ophys_timestamps: OphysTimestamps, excitation_lambda=910.0) ImagingPlane[source]

Populates a DataFile from a JSON compatible dict (likely parsed by argschema)

Returns:
DataObject:

An instantiated DataObject which has name and value properties

classmethod from_lims(ophys_experiment_id: int, lims_db: PostgresQueryMixin, ophys_timestamps: OphysTimestamps, excitation_lambda=910.0) ImagingPlane[source]

Populate a DataObject from an internal database (likely LIMS)

Returns:
DataObject:

An instantiated DataObject which has name and value properties

classmethod from_nwb(nwbfile: NWBFile) ImagingPlane[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

property indicator: str | None
property ophys_frame_rate: float
property targeted_structure: str