allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.equipment module

class allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.equipment.Equipment(equipment_name: str)[source]

Bases: DataObject, JsonReadableInterface, LimsReadableInterface, NwbReadableInterface, NwbWritableInterface

the name of the experimental rig.

classmethod from_json(dict_repr: dict) → Equipment[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: PostgresQueryMixin) → Equipment[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: NWBFile) → Equipment[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

to_nwb(nwbfile: NWBFile) → NWBFile[source]

Given an already populated DataObject, return an pyNWB file object that had had DataObject data added.

Parameters:
nwbfileNWBFile

An NWB file object

Returns:
NWBFile

An NWB file object that has had data from the DataObject added to it.

property type
class allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.equipment.EquipmentType(value)[source]

Bases: Enum

An enumeration.

MESOSCOPE = 'MESOSCOPE'
OTHER = 'OTHER'