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: allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.ophys_session_id.OphysSessionId, experiment_container_id: allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.experiment_container_id.ExperimentContainerId, field_of_view_shape: allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.field_of_view_shape.FieldOfViewShape, imaging_depth: allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.imaging_depth.ImagingDepth, imaging_plane_group: allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.multi_plane_metadata.imaging_plane_group.ImagingPlaneGroup, project_code: allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.project_code.ProjectCode)[source]

Bases: allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.ophys_experiment_metadata.OphysExperimentMetadata

classmethod from_json(dict_repr: dict) → 'MultiplaneMetadata'[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: allensdk.internal.api.PostgresQueryMixin) → 'MultiplaneMetadata'[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: pynwb.file.NWBFile) → 'MultiplaneMetadata'[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
imaging_plane_group
imaging_plane_group_count