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)[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

classmethod from_json(dict_repr: dict) → 'ImagingPlaneGroup'[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) → Union[ForwardRef('ImagingPlaneGroup'), NoneType][source]
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: pynwb.file.NWBFile) → 'ImagingPlaneGroup'[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
plane_group
plane_group_count