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

class allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.ophys_experiment_metadata.OphysExperimentMetadata(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, project_code: Optional[allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.project_code.ProjectCode] = None)[source]

Bases: allensdk.core._data_object_base.data_object.DataObject, allensdk.core._data_object_base.readable_interfaces.LimsReadableInterface, allensdk.core._data_object_base.readable_interfaces.JsonReadableInterface, allensdk.core._data_object_base.readable_interfaces.NwbReadableInterface

Container class for ophys experiment metadata

experiment_container_id
field_of_view_shape
classmethod from_json(dict_repr: dict) → 'OphysExperimentMetadata'[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) → 'OphysExperimentMetadata'[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) → 'OphysExperimentMetadata'[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_depth
ophys_experiment_id
ophys_session_id
project_code