allensdk.brain_observatory.behavior.data_objects.eye_tracking.rig_geometry module

class allensdk.brain_observatory.behavior.data_objects.eye_tracking.rig_geometry.Coordinates(x: float, y: float, z: float)[source]

Bases: object

Represents coordinates in 3d space

property x
property y
property z
class allensdk.brain_observatory.behavior.data_objects.eye_tracking.rig_geometry.RigGeometry(equipment: str, monitor_position_mm: Coordinates, monitor_rotation_deg: Coordinates, camera_position_mm: Coordinates, camera_rotation_deg: Coordinates, led_position: Coordinates)[source]

Bases: DataObject, LimsReadableInterface, JsonReadableInterface, NwbReadableInterface, NwbWritableInterface

property camera_position_mm
property camera_rotation_deg
property equipment
classmethod from_json(dict_repr: dict) → RigGeometry[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(lims_db: PostgresQueryMixin, behavior_session_id: int | None = None, ophys_experiment_id: int | None = None) → RigGeometry | None[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) → RigGeometry | None[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

property led_position
property monitor_position_mm
property monitor_rotation_deg
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.