opiPresent_for_PhoneHMD {OPI}R Documentation

Implementation of opiPresent for the PhoneHMD machine.

Description

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

Arguments

stim

A list containing:

  • lum List of stimuli luminances (cd/m^2).

  • stim.length The number of elements in this stimuli.

  • color1 List of stimulus colors for FLAT shapes and patterns.

  • sx List of diameters along major axis of ellipse (degrees).

  • sy List of diameters along minor axis of ellipse (degrees).

  • eye The eye for which to apply the settings.

  • t List of stimuli presentation times (ms). If 0, then the next stim list element will be shown simultaneously.

  • w Time to wait for response including presentation time (ms).

  • x List of x co-ordinates of stimuli (degrees).

  • y List of y co-ordinates of stimuli (degrees).

  • envSdx (Optional) List of envelope sd in x direction in degrees. Only useful if envType != NONE

  • envSdy (Optional) List of envelope sd in y direction in degrees. Only useful if envType != NONE

  • envRotation (Optional) List of envelope rotations in degrees. Only useful if envType != NONE

  • type (Optional) Stimulus type. Values include FLAT, SINE, CHECKERBOARD, SQUARESINE, G1, G2, G3, IMAGE

  • frequency (Optional) List of frequencies (in cycles per degrees) for generation of spatial patterns. Only useful if type != FLAT

  • color2 (Optional) List of second colors for non-FLAT shapes

  • fullFoV (Optional) If !0 fullFoV scales image to full field of view and sx/sy are ignored.

  • phase (Optional) List of phases (in degrees) for generation of spatial patterns. Only useful if type != FLAT

  • imageFilename (Optional) If type == IMAGE, the filename on the local filesystem of the machine running JOVP of the image to use

  • shape (Optional) Stimulus shape. Values include CROSS, TRIANGLE, CIRCLE, SQUARE, OPTOTYPE.

  • rotation (Optional) List of angles of rotation of stimuli (degrees). Only useful if sx != sy specified.

  • texRotation (Optional) List of angles of rotation of stimuli (degrees). Only useful if type != FLAT

  • defocus (Optional) List of defocus values in Diopters for stimulus post-processing.

  • envType (Optional) List of envelope types to apply to the stims). Only useful if type != FLAT

  • contrast (Optional) List of stimulus contrasts (from 0 to 1). Only useful if type != FLAT.

  • optotype (Optional) If shape == OPTOTYPE, the letter A to Z to use

...

Parameters for other opiPresent implementations that are ignored here.

Details

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

stim.length can take on values in the range [1, 2147483647].

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

Elements in sx can take on values in the range [0.0, 180.0].

Elements in sy can take on values in the range [0.0, 180.0].

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

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

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

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

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

Elements in envSdx can take on values in the range [-1.0E10, 1.0E10].

Elements in envSdy can take on values in the range [-1.0E10, 1.0E10].

Elements in envRotation can take on values in the range [-1.0E10, 1.0E10].

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

Elements in frequency can take on values in the range [0.0, 300.0].

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

Elements in fullFoV can take on values in the range [-1.0E10, 1.0E10].

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

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

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

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

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

Elements in envType can take on values in the set {"none", "square", "circle", "gaussian"}.

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

Elements in optotype can take on values in the set {"a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"}.

Value

A list containing:

See Also

opiPresent()

Examples

chooseOpi("PhoneHMD")
opiInitialise(list(port = 50001, ip = "localhost"))
opiSetup(list(eye = "BOTH"))
result <- opiPresent(stim = list(lum = list(300.0), stim.length = 1, color1 = list(list(1.0,
                  1.0, 1.0)), sx = list(1.72), sy = list(1.72),
                  eye = list("LEFT"), t = list(200.0), w = 1500.0, x = list(0.0), y = list(0.0)))


[Package OPI version 3.0.2 Index]