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

class allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.imaging_depth.ImagingDepth(imaging_depth: int)

Bases: DataObject, LimsReadableInterface, NwbReadableInterface, JsonReadableInterface

Data object loads and stores the imaging_depth (microns) for an experiments. This is the calculated difference between measured z-depths of the surface and imaging_depth.

classmethod from_json(dict_repr: dict) → ImagingDepth

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

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

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