 |
EyeLogic SDK
1.2.3
|
|
|
def | check_bool (result, func, args) |
| |
|
|
| GazeSampleCallback = CFUNCTYPE(None, POINTER(ELGazeSample)) |
| | callback function type, new gaze samples
|
| |
|
| DeviceEventCallback = CFUNCTYPE(None, c_int32) |
| | callback function type, event occurred
|
| |
|
| EyeImageCallback = CFUNCTYPE(None, POINTER(ELEyeImage)) |
| | callback function type, new eye image
|
| |
|
| libname = os.path.join("x64", "ELCApi") |
| |
|
| baseDir = os.path.dirname(os.path.abspath(__file__)) |
| |
|
| libnameGlobal = os.path.join(baseDir, libname + ".dll") |
| |
|
| kernel32 = WinDLL('kernel32', use_last_error=True) |
| |
|
| errcheck |
| |
|
| restype |
| |
|
| argtypes |
| |
|
| c_libH = kernel32.LoadLibraryExW(libnameGlobal, None, 0x00000008) |
| |
|
| c_lib = WinDLL(libname, handle=c_libH) |
| |
|
| ELInvalidValue = c_double.in_dll(c_lib, "ELCInvalidValue").value |
| | marker for an invalid double value
|
| |
This module contains the python prototype declaration for all functions which are neccessary to control the EyeLogic software from an API client.
def __init__(self, mmBelowScreen, mmTrackerInFrontOfScreen)
constructor
Definition: ELApi.py:422
Version getApiVersion(self)
get version (revision) of this API
Definition: ELApi.py:211
def __init__(self, deviceSerial)
constructor
Definition: ELApi.py:469
(ReturnValidate, ValidationResult) validateCustom(self, c_int backgroundColor, str targetFilename)
perform validation (method is blocking until calibration finished) - calibration must be performed pr...
Definition: ELApi.py:832
ReturnConnect connectRemote(self, ServerInfo server)
initialize connection to a remote server (method is blocking until connection established)
Definition: ELApi.py:273
def calibrateCustom(self, c_int calibrationModeInd, c_int backgroundColor, str targetFilename)
perform calibration (method is blocking until calibration finished)
Definition: ELApi.py:701
contains an eye image at a specific time
Definition: ELApi.py:103
major
major version number
Definition: ELApi.py:203
(ReturnNextData, ELDeviceEvent) getNextDeviceEvent(self, c_int timeoutMillis)
Obtains the next unread event or blocks until a new event occurs or the given timeout is reached.
Definition: ELApi.py:564
connection information for an EyeLogic server
Definition: ELApi.py:257
isDemoDevice
whether the device is for DEMO use only, not for public sale
Definition: ELApi.py:477
(ReturnNextData, ELGazeSample) getNextGazeSample(self, c_int timeoutMillis)
Obtains the next unread gazeSample or blocks until a new GazeSample is received or the given timeout ...
Definition: ELApi.py:590
def abortCalibValidation(self)
abort a running calibration / validation
Definition: ELApi.py:711
ReturnConnect connect(self)
initialize connection to the server (method is blocking until connection established).
Definition: ELApi.py:250
def unrequestTracking(self)
unrequest tracking
Definition: ELApi.py:657
def __del__(self)
destructor
Definition: ELApi.py:165
return values of connect( )
Definition: ELApi.py:234
ReturnSetActiveScreen setActiveScreen(self, str id, DeviceGeometry deviceGeometry)
Make a screen connected to this machine to the active screen.
Definition: ELApi.py:449
def calibrate(self, c_int calibrationModeInd)
perform calibration (method is blocking until calibration finished)
Definition: ELApi.py:683
main class for communication with the EyeLogic server
Definition: ELApi.py:150
deviceName
name of the device
Definition: ELApi.py:473
return values of requestTracking( )
Definition: ELApi.py:625
validationPointPxY
ELInvalidValue or y-coordinate of stimulus point position.
Definition: ELApi.py:750
meanDeviationLeftDeg
ELInvalidValue or mean deviation of left eye gaze direction in [deg] in the 3-D world system.
Definition: ELApi.py:756
def registerGazeSampleCallback(self, GazeSampleCallback sampleCallback)
registers sample callback listener
Definition: ELApi.py:170
meanDeviationRightPx
ELInvalidValue or mean deviation between right eye POR and stimulus position in [px] in the stimulus ...
Definition: ELApi.py:759
def __init__(self, str clientName)
constructor
Definition: ELApi.py:156
deviceSerial
serial number
Definition: ELApi.py:471
contains all information about the state of the eyes at a specific time
Definition: ELApi.py:65
brandedName
name of the license owner
Definition: ELApi.py:475
minor
minor version number
Definition: ELApi.py:205
meanDeviationRightDeg
ELInvalidValue or mean deviation of right eye gaze direction in [deg] in the 3-D world system.
Definition: ELApi.py:762
pointsData
Number of validation points.
Definition: ELApi.py:772
frameRates
list of supported frame rates
Definition: ELApi.py:479
return values of streamEyeImages( )
Definition: ELApi.py:516
mmBelowScreen
distance of eye tracker below the bottom line of the screen [mm]
Definition: ELApi.py:424
def registerEyeImageCallback(self, EyeImageCallback eyeImageCallback)
registers eye image callback listener
Definition: ELApi.py:180
def __init__(self)
constructor
Definition: ELApi.py:201
return values of setActiveScreen( )
Definition: ELApi.py:429
return values of calibrate( )
Definition: ELApi.py:664
meanDeviationLeftPx
ELInvalidValue or mean deviation between left eye POR and stimulus position in [px] in the stimulus p...
Definition: ELApi.py:753
validationPointPxX
ELInvalidValue or x-coordinate of stimulus point position.
Definition: ELApi.py:748
[ServerInfo] requestServerList(self, c_int32 blockingDurationMS, c_int32 maxNumServer)
Ping all running EyeLogic servers in the local network and wait some time for their response.
Definition: ELApi.py:296
return values of getNextDeviceEvent( ), getNextGazeSample( ) and getNextEyeImage( )
Definition: ELApi.py:538
def __init__(self)
constructor
Definition: ELApi.py:259
geometric position of the device related to the active monitor
Definition: ELApi.py:417
(ReturnNextData, ELEyeImage) getNextEyeImage(self, c_int timeoutMillis)
Obtains the next unread eye image or blocks until a new eye image is received or the given timeout is...
Definition: ELApi.py:616
def disconnect(self)
closes connection to the server
Definition: ELApi.py:318
def registerDeviceEventCallback(self, DeviceEventCallback deviceEventCallback)
registers event callback listener
Definition: ELApi.py:190
configuration of the eye tracker
Definition: ELApi.py:466
physicalSizeY_mm
vertical physical dimension of the screen [mm]
Definition: ELApi.py:348
ReturnStart requestTracking(self, c_int frameRateModeInd)
request tracking
Definition: ELApi.py:647
ReturnStreamEyeImages streamEyeImages(self, c_bool enable)
Enabled/disables eye image stream.
Definition: ELApi.py:530
ValidationResult.
Definition: ELApi.py:768
configuration of the stimulus screen
Definition: ELApi.py:332
port
port of server
Definition: ELApi.py:263
ip
IP address of server as 0-terminated string.
Definition: ELApi.py:261
build
build number
Definition: ELApi.py:207
localMachine
whether this screen is connected to the local PC
Definition: ELApi.py:336
mmTrackerInFrontOfScreen
distance of front panel of the eye tracker in front of the screen[mm]
Definition: ELApi.py:426
bool isConnected(self)
whether a connection to the server is established
Definition: ELApi.py:325
DeviceConfig getDeviceConfig(self)
get configuration of actual eye tracker device
Definition: ELApi.py:485
name
Name of the screen.
Definition: ELApi.py:340
id
ID of the screen.
Definition: ELApi.py:338
physicalSizeX_mm
horizontal physical dimension of the screen [mm]
Definition: ELApi.py:346
ValidationPointResult.
Definition: ELApi.py:745
resolutionY
screen Y resolution [px]
Definition: ELApi.py:344
resolutionX
screen X resolution [px]
Definition: ELApi.py:342
total version is major.minor.build
Definition: ELApi.py:199
def __init__(self)
constructor
Definition: ELApi.py:334
Events coming from the eye tracker.
Definition: ELApi.py:89
[ScreenConfig] getAvailableScreens(self)
Get a list of screens connected to the local machine.
Definition: ELApi.py:385
calibrationMethods
list of supported calibration methods (number of shown points)
Definition: ELApi.py:481
return values of validate( )
Definition: ELApi.py:716
ScreenConfig getActiveScreen(self)
get stimulus screen configuration
Definition: ELApi.py:352
(ReturnValidate, ValidationResult) validate(self)
perform validation (method is blocking until calibration finished) - calibration must be performed pr...
Definition: ELApi.py:780