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)

Bases: allensdk.core._data_object_base.data_object.DataObject, allensdk.core._data_object_base.readable_interfaces.JsonReadableInterface, allensdk.core._data_object_base.readable_interfaces.LimsReadableInterface, allensdk.core._data_object_base.readable_interfaces.NwbReadableInterface, allensdk.core._data_object_base.writable_interfaces.JsonWritableInterface, allensdk.core._data_object_base.writable_interfaces.NwbWritableInterface

the name of the experimental rig.

classmethod from_json(dict_repr: dict) → 'Equipment'

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) → 'Equipment'

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) → 'Equipment'

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_json(self) → dict

Given an already populated DataObject, return the dict that when used with the from_json() classmethod would produce the same DataObject

Returns:

dict:

The JSON (in dict form) that would produce the DataObject.

to_nwb(self, nwbfile: pynwb.file.NWBFile) → pynwb.file.NWBFile

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

Parameters:

nwbfile : NWBFile

An NWB file object

Returns:

NWBFile

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

type

class allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.equipment.EquipmentType

Bases: enum.Enum

An enumeration.

MESOSCOPE = 'MESOSCOPE'

OTHER = 'OTHER'