allensdk.brain_observatory.behavior.data_objects.metadata.behavior_ophys_metadata module¶

class allensdk.brain_observatory.behavior.data_objects.metadata.behavior_ophys_metadata.BehaviorOphysMetadata(behavior_metadata: BehaviorMetadata, ophys_metadata: OphysExperimentMetadata | MultiplaneMetadata)[source]¶

Bases: DataObject, LimsReadableInterface, JsonReadableInterface, NwbReadableInterface, NwbWritableInterface

classmethod from_json(dict_repr: dict, is_multiplane=False) → BehaviorOphysMetadata[source]¶

Parameters:

dict_repr
is_multiplane: Whether to fetch metadata for an experiment that is part of a container containing multiple imaging planes

Returns:

classmethod from_lims(ophys_experiment_id: int, lims_db: PostgresQueryMixin, is_multiplane=False) → BehaviorOphysMetadata[source]¶

Parameters:

ophys_experiment_id
lims_db
is_multiplane: Whether to fetch metadata for an experiment that is part of a container containing multiple imaging planes

classmethod from_nwb(nwbfile: NWBFile, is_multiplane=False) → BehaviorOphysMetadata[source]¶

Parameters:

nwbfile
is_multiplane: Whether to fetch metadata for an experiment that is part of a container containing multiple imaging planes

to_nwb(nwbfile: NWBFile) → NWBFile[source]¶

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

Parameters:

Returns:

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

update_targeted_imaging_depth(ophys_experiment_ids: List[int], lims_db: PostgresQueryMixin)[source]¶

Update the value for targeted imaging depth given a set of experiments to be published.

Compute the targeted_imaging_depth (average over experiments in a container) only for those experiments input.

Parameters:

ophys_experiment_idslist of ints: Set of experiments to calculate targeted_imaging_depth for. Needs to contain the experiment this metadata represents.
lims_dbPostgresQueryMixin: Connection to the LIMS2 database.