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

class allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.multi_plane_metadata.imaging_plane_group.ImagingPlaneGroup(plane_group: int, plane_group_count: int)

Bases: DataObject, LimsReadableInterface, JsonReadableInterface, NwbReadableInterface

classmethod from_json(dict_repr: dict) → ImagingPlaneGroup

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) → ImagingPlaneGroup | None

Parameters:

ophys_experiment_id

lims_db

Returns:

ImagingPlaneGroup instance if ophys_experiment given by

ophys_experiment_id is part of a plane group

else None

classmethod from_nwb(nwbfile: NWBFile) → ImagingPlaneGroup

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

property plane_group

property plane_group_count