opiSetup_for_Octopus900: Implementation of opiSetup for the Octopus900 machine.

View source: R/Octopus900.r

opiSetup_for_Octopus900R Documentation

Implementation of opiSetup for the Octopus900 machine.

Description

This is for internal use only. Use opiSetup() with the same parameters.

Arguments

lum

Luminance level in cd/m^2

color

Stimulus color (see details)

fixation

fixation target

fixIntensity

fixation point intensity

Details

Allowable lum and color are defined in the .opi_env$O900 environment.

  • lum is intensity of the background and can be one of

    • .opi_env$O900$BG_OFF, which turns background off.

    • .opi_env$O900$BG_1, background of 1.27 cd/\mbox{m}^2.

    • .opi_env$O900$BG_10, background of 10 cd/\mbox{m}^2.

    • .opi_env$O900$BG_100, background of 100 cd/\mbox{m}^2.

  • color can be one of the following choices.

    • .opi_env$O900$MET_COL_WW for white-on-white

    • .opi_env$O900$MET_COL_RW for red-on-white

    • .opi_env$O900$MET_COL_BW for blue-on-white

    • .opi_env$O900$MET_COL_WY for white-on-yellow

    • .opi_env$O900$MET_COL_RY for red-on-yellow

    • .opi_env$O900$MET_COL_BY for blue-on-yellow

  • fixation is one of

    • .opi_env$O900$FIX_CENTRE or .opi_env$O900$FIX_CENTER

    • .opi_env$O900$FIX_CROSS

    • .opi_env$O900$FIX_RING

  • fixIntensity is a percentage between 0 and 100. 0 is off, 100 the brightest.

Note if you specify fixation you also have to specify fixIntensity.

Value

A list with element err which is

  • NULL on success

  • -1 indicates opiInitialize has not been called.

  • -2 indicates could not set the background color.

  • -3 indicates could not set the fixation marker.

  • or a string message about bad parameters

Examples

## Not run: 
  chooseOpi("Octopus900")
  oi <- opiInitialize(eyeSuiteJarLocation="c:/EyeSuite/",
                      eyeSuiteSettingsLocation="c:/Documents and Settings/All Users/Haag-Streit/",
                      eye="left")
  if(!is.null(oi$err))
      stop("opiInitialize failed")
  if(!is.null(opiSetup(fixation=.opi_env$O900$FIX_CENTRE)$err))
      stop("opiSetup failed")
  if(!is.null(opiSetup(fixation=.opi_env$O900$FIX_RING, fixIntensity=0)$err))
      stop("opiSetup failed")
  if(!is.null(opiSetup(color=.opi_env$O900$MET_COL_BY)$err))
      stop("opiSetup failed")
  if(!is.null(opiSetup(lum=.opi_env$O900$BG_100, color=.opi_env$O900$MET_COL_RW)$err))
      stop("opiSetup failed")
  opiClose()

## End(Not run)

OPI documentation built on April 12, 2025, 1:24 a.m.