allensdk.brain_observatory.behavior.data_files.eye_tracking_video module

class allensdk.brain_observatory.behavior.data_files.eye_tracking_video.EyeTrackingVideo(filepath: str | Path, **kwargs)

Bases: DataFile

Eye tracking video

classmethod from_json(dict_repr: dict) → DataFile

Populates a DataFile from a JSON compatible dict (likely parsed by argschema)

Returns:

DataFile:

An instantiated DataFile which has data and filepath properties

classmethod from_lims(db: PostgresQueryMixin, behavior_session_id: int | str, session_type: str = 'OphysSession') → EyeTrackingVideo

Parameters:

db: PostgresQueryMixin

behavior_session_id: behavior session id

session_type: session type the eye tracking video is associated with.

Either ‘OphysSession’ or ‘EcephysSession’

Returns:

EyeTrackingVideo instance

static load_data(filepath: str | Path, **kwargs) → Any

Given a filepath (that is meant to by read by the DataFile type), load the contents of the file into a Python type. (dict, DataFrame, list, etc…)

Parameters:

filepathUnion[str, Path]

The filepath that the DataFile class should load.

Returns:

Any

A Python data type that has been parsed/loaded from the provided filepath.