ROI Element

Summary ¶

	ROI
Info
Category:	Input Registration		AddIn:	Base Layer
Creator:	OkazoLab		Scope:	Parent event
Owns Snippets:	None		Usage:	Stimulus screen

Properties ¶

Name	Description	Constraints	Type	On runtime change
Control
Is Enabled	If set to false the element is completely omitted when the experiment is run	Design Time..	Boolean
Title	Title of the element	Design Time..	String
Settings
Area Shape	Defines the shape of the monitored area on the screen	Design Time..	stTarg..
Tracking Device	Defines which of the radar providers is used for positional input in this event. In each experiment, the radar providers includes the system mouse and all tracker elements. The selected radar provider controls the Radar Point property and input to the AOI elements in this event. When 'Auto' is chosen, the first tracker element is picked up. If there are no tracker elements, the system mouse is used by default.	Design Time..	String
Border Visible	Defines whether a border is shown around the element's viewport at runtime	Normal..	Boolean
Triggering Mode	Defines the triggering mode of the element, namely, what pattern of tracking positions is detected and signaled by the element	Design Time..	stTarg..
Fixation Duration	Defines the minimal fixation duration (in ms) that triggers the element, when its triggering mode is set to the “fixation”. For other triggering modes, the property value is ignored.	Normal..	clTime
Runtime Status
Is Over	Indicates, whether the tracking position is currently inside of the region of interest	Normal..	Boolean
Last Crossing Direction	Indicates the last crossing direction relatevely to the ROI boundaries. The returned code means: 0- no crossing yet, 1- crossing into the ROI, 2- crossing out of the ROI.	Status..	Int32
Is Triggered	Indicates whether the element gets triggered in response to detected pattern of tracking positions, set by the Triggering Mode property.	Normal..	Boolean
Triggering Time	Returns local event time, when the element has been triggered.	Status..	clTime
Dwell Time	Returns the accumulated time of tracking positions being inside of the ROI area. The value can grow until the event's offset, independently of the element's triggering state.	Normal..	clTime
Visual Appearance
Alpha Masking	Defines, whether the visual content is used to create an opacity mask on the event surface. If masking is on, the content's pixel luminance (or, its inverse) defines transparency within element's viewport. The alpha masking allows, for example, create transparent holes on the event surface.	Design Time..	Int32
AntiAliasing	if true, the rendered content will be antialiased for smoother visual appeariance. If false, rendering will be authentic to its source, e.g. a bitmap.	Normal..	Boolean
Position	Defines a position of the rendering viewport on the screen	Normal..	clPoint
Size	Defines a size of the element's rendering viewport on the screen	Normal..	clSize
Z Order	Indicates Z Order of the element on the given event	Status..	Int32
Pivot Point	Defines alignment of the pivot point (or, element's position) relative to element's rendering area. The pivot point sets the center of element's rotation and scale directions.	Normal..	stAlig..
Visible	Defines whether the element is visible	Normal..	Boolean
Effects
Transparent Color	The color of the original pixels of rendered content that will be set as transparent	Normal..	stColor
Transparent Tolerance	Tolerance ratio for choosing colors that become transparent. Zero means that effect is not applied, 1 denotes that all colors will become trasparent	Normal..	Int32
Color Mask	Produces a multiplicative combination of the original pixels and the selected mask color (except the alpha channel).  The effect emulates a look through a colored glass.  White or transparent mask color dont change the original pixels	Normal..	stColor
Opacity	Opacity of the rendered content	Normal..	Int32
Contrast	Contrast of the rendered content	Normal..	Int32
Brightness	Brightness the rendered content	Normal..	Int32
Saturation	Saturation of the rendered content	Normal..	Double
Pixelation	Pixelation of the rendered content	Normal..	Int32
Blurring	The radius used in the gaussian blur of rendered content, as a pixel-based factor. The default is 0 which means no blurring.	Normal..	Int32
Scrambling		Normal..	Double
Scrambling Grid Size	Defines a size of the scrambling grid	Normal..	clSize
Positional Jitter
Reset Jitter Now	Runtime command that resets the positional jitter.	Runtime Command..	Boolean
Current Jitter	Returns the current jitter	Status..	clPoint
Jitter Range	Defines a possible range for the random jitter. The range is centered to the position of the element.	Normal..	clSize

¶

Practical use ¶

On the first spot ¶

On perpetual fixation ¶

On fixation break ¶

Notes ¶

• The ROI element can be triggered only once during the parent event. If you need multiple triggering, redesign your experiment flow (e.g. use several events) or reactivate the parent event. Alternatively, you can still read 'Is Over' property of the element that provides a status of positional input even after the element has been triggered.
• the ROI element can be affected by the solar visual transformations, if they are applied to the parent event. In such cases, relations between positional input and watched areas can be incorrectly estimated. Always place radar area elements in events that have no such transformations.
• if you have several active ROI elements that monitor the same screen area, they can be triggered at the same time.