allensdk.brain_observatory.behavior.data_objects.metadata.subject_metadata.mouse_id module

class allensdk.brain_observatory.behavior.data_objects.metadata.subject_metadata.mouse_id.MouseId(mouse_id: 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

the LabTracks ID

classmethod from_json(dict_repr: dict) → 'MouseId'[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(behavior_session_id: int, lims_db: allensdk.internal.api.PostgresQueryMixin) → 'MouseId'[source]

Populate a DataObject from an internal database (likely LIMS)

Returns:
DataObject:

An instantiated DataObject which has name and value properties
classmethod from_nwb(nwbfile: pynwb.file.NWBFile) → 'MouseId'[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