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

class allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.multi_plane_metadata.multi_plane_metadata.MultiplaneMetadata(ophys_experiment_id: int, ophys_session_id: OphysSessionId, ophys_container_id: OphysContainerId, field_of_view_shape: FieldOfViewShape, imaging_depth: ImagingDepth, targeted_imaging_depth: TargetedImagingDepth, imaging_plane_group: ImagingPlaneGroup, project_code: OphysProjectCode = <allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.ophys_project_code.OphysProjectCode object>)

Bases: OphysExperimentMetadata

classmethod from_json(dict_repr: dict) → MultiplaneMetadata

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) → MultiplaneMetadata

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) → MultiplaneMetadata

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 imaging_plane_group: int

property imaging_plane_group_count: int