Types

This is where we define the base data components needed for higher level functionality.

vision types

source

Region

 Region (left:int, top:int, right:int, bottom:int)

a Region defines the four corners of the box to be recorded.

reg = Region(left=0, top=0, right=1280, bottom=720)
reg
Region(left=0, top=0, right=1280, bottom=720)

source

Window

 Window (app_name:str, sub_region:__main__.Region=None)
win = Window(app_name='notepad.exe', sub_region=reg)
win
Window(app_name='notepad.exe', sub_region=Region(left=0, top=0, right=1280, bottom=720))

a Window represents our reference to an application and the Region within we want to record. when Region is None, we record the entire application window.

observation types

source

VisualEventObservation

 VisualEventObservation (timestamp:datetime.datetime, data:Any)

VisualEventObservation is the visual stimuli collected and the timestamp it was observed.

source

SoundSequenceObservation

 SoundSequenceObservation (start_timestamp:datetime.datetime,
                           end_timestamp:datetime.datetime, data:Any)

SoundSequenceObservation is an observed audio sequence for a fixed period of time

source

GamepadEventObservation

 GamepadEventObservation (timestamp:datetime.datetime, code:str,
                          state:int)

GamepadEventObservation is the gamepad event observed and the timestamp it was observed.

source

VibrationEventObservation

 VibrationEventObservation (timestamp:datetime.datetime, motor:str,
                            speed:float)

VibrationEventObservation is the vibration event observed and the timestamp it was observed.

source

DiscreteEvent

 DiscreteEvent (event_index:int, timestamp:datetime.datetime,
                VisualEvents:List[__main__.VisualEventObservation],
                GamepadEvents:List[__main__.GamepadEventObservation],
                VibrationEvents:List[__main__.VibrationEventObservation],
                SoundSequence:__main__.SoundSequenceObservation)

DiscreteEvent is the representation formed via observing a slice of time

source

Episode

 Episode (events:List[__main__.DiscreteEvent], meta_data:Dict[str,Any])

Episode is the representation of a sequence of DiscreteEvents and the contextualizing meta_data we decide to record with it.