opiSetup_for_ImoVifa: Implementation of opiSetup for the ImoVifa machine.
In OPI: Open Perimetry Interface

View source: R/ImoVifa.r

opiSetup_for_ImoVifa

R Documentation

Implementation of opiSetup for the ImoVifa machine.

Description

This is for internal use only. Use opiSetup() after chooseOPI("ImoVifa") to call this function.

Arguments

settings

A list containing:

eye The eye for which to apply the settings.
bgImageFilename (Optional) If present, display the image in the background for eye (scaled to fill fov, bgLum and bgCol ignored)
fixShape (Optional) Fixation target type for eye.
fixLum (Optional) Fixation target luminance for eye.
fixType (Optional) Fixation target texture for eye.
fixCx (Optional) x-coordinate of fixation target (degrees).
fixCy (Optional) y-coordinate of fixation target (degrees).
fixCol (Optional) Fixation target color for eye.
bgLum (Optional) Background luminance for eye (cd/m^2).
tracking (Optional) Whether to correct stimulus location based on eye position.
bgCol (Optional) Background color for eye (rgb).
fixSx (Optional) diameter along major axis of ellipse (degrees). 0 to hide fixation marker.
fixSy (Optional) diameter along minor axis of ellipse (degrees). If not received, then sy = sx.
fixRotation (Optional) Angles of rotation of fixation target (degrees). Only useful if sx != sy specified.
fixImageFilename (Optional) If fixType == IMAGE, the filename on the local filesystem of the machine running JOVP of the image to use

Details

eye can take on values in the set {"left", "right", "both", "none"}.

fixShape can take on values in the set {"triangle", "square", "polygon", "hollow_triangle", "hollow_square", "hollow_polygon", "cross", "maltese", "circle", "annulus", "optotype", "text", "model"}.

fixLum can take on values in the range [0.0, 1.0E10].

fixType can take on values in the set {"flat", "checkerboard", "sine", "squaresine", "g1", "g2", "g3", "text", "image"}.

fixCx can take on values in the range [-90.0, 90.0].

fixCy can take on values in the range [-90.0, 90.0].

Elements in fixCol can take on values in the range [0.0, 1.0].

bgLum can take on values in the range [0.0, 1.0E10].

tracking can take on values in the range [0, 1].

Elements in bgCol can take on values in the range [0.0, 1.0].

fixSx can take on values in the range [0.0, 1.0E10].

fixSy can take on values in the range [0.0, 1.0E10].

fixRotation can take on values in the range [0.0, 360.0].

Value

A list containing:

err NULL if there was no error, a string message if there is an error.

Examples

## Not run: 
chooseOpi("ImoVifa")
opiInitialise(list(port = 50001, ip = "localhost"))
result <- opiSetup(settings = list(eye = "BOTH"))

## End(Not run)

OPI documentation built on Nov. 5, 2025, 6:09 p.m.