Skip to content

← gaze package

SetGazeMetaData

Overwrite the screen-related metadata of a gaze stream.

Will fall back to the current screen if parameters not specified. This node is best used before using the GazeScreenCoordinateConversion node to facilitate conversion of gaze units. It is often necessary to convert gaze units prior to using the ExtractGazeEvents node whose default parameters expect certain units. Version 0.0.3

Ports/Properties

data

Data to process.

verbose name
Data
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
INOUT

screen_index

If the screen resolution and dimensions arguments are not provided then the fallback will use the screen dimensions of one of the connected screens. Set this argument to the index of the attached screen from which to extract the dimensions. Defaults to 0 (first display).

verbose name
Screen Number
default value
None
port type
IntPort
value type
int (can be None)

screen_distance

Viewer distance from screen in meters.

verbose name
Screen Distance
default value
None
port type
FloatPort
value type
float (can be None)

screen_resolution

[X, Y] screen resolution in pixels. This argument must be complemented with either screen_dimensions or screen_dpi, otherwise this value is not used and the fallback will be used.

verbose name
Screen Resolution
default value
None
port type
ListPort
value type
list (can be None)

screen_dimensions

[X, Y] screen width and height dimensions in meters. (For reference: 24 inches = 0.61 m; 27 inches = 0.69 m)

verbose name
Screen Dimensions
default value
None
port type
ListPort
value type
list (can be None)

screen_dpi

Screen pixel density measured in Dots Per Inch.

verbose name
Screen Dpi
default value
None
port type
FloatPort
value type
float (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)