allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.targeted_imaging_depth module¶
- class allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.targeted_imaging_depth.TargetedImagingDepth(targeted_imaging_depth: int)[source]¶
Bases:
DataObject,LimsReadableInterface,NwbReadableInterface,JsonReadableInterfaceData object loads and stores the average `imaging_depth`s (microns) across experiments in the container that an experiment is associated with.
- classmethod from_json(dict_repr: dict) TargetedImagingDepth[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_experiment_ids: List[int] | None = None) TargetedImagingDepth[source]¶
Load targeted imaging depth.
- Parameters:
- ophys_experiment_idint
Id of experiment to calculate targeted depth for.
- lims_dbPostgresQueryMixin
Connection to the LIMS2 database.
- ophys_experiment_idslist of int
Subset of experiments in the container of
ophys_experiment_idto calculate the target_imaging_depth. List should contain the value ofophys_experiment_id.
- classmethod from_nwb(nwbfile: NWBFile) TargetedImagingDepth[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