userFunctions Class Reference

Customised user functions for a task run. More...

Detailed Description

Customised user functions for a task run.

The state machine's job is to run a set of functions when entering and exiting states. Most required functions (methods in classes) are found in the core opticka classes like screenManager, stateMachine etc. BUT if a user wants to customise their own functions then we need to have a generic class we can load and use where they can add their own methods. This class serves this purpose.

The user should make a copy of this file and save it somewhere alongside their protocols (you can rename the file, but keep the class name the same). They can add their own methods. The class will be added as a uF object and these methods can be used via the state info file.

Copyright ©2014-2023 Ian Max Andolina — released: LGPL3, see LICENCE.md

Inheritance diagram for userFunctions:

Public Member Functions
function	userFunctions ()
function	setDelayTimeWithStaircase (in me, in stim, in duration)
function	resetDelayTime (in me, in stim, in value)
function	testFunction (in me)

Public Attributes
Property	rE
	runExperiment
Property	sM
	stateMachine
Property	s
	screenManager
Property	task
	taskSequence
Property	stims
	metaStimulus stimluli
Property	rM
	reward manager
Property	io
	I/O manager.
Property	eT
	eyetracker manager
Property	verbose
	toggle to send messages to the command window

Constructor & Destructor Documentation

userFunctions()

function userFunctions::userFunctions

(

)

Member Function Documentation

resetDelayTime()

function userFunctions::resetDelayTime	(	in	me,
		in	stim,
		in	value
	)

uses a staircase to set the off time for a specific stimulus

setDelayTimeWithStaircase()

function userFunctions::setDelayTimeWithStaircase	(	in	me,
		in	stim,
		in	duration
	)

userFunctions CONSTRUCT an instance of this class Rename to the name of the class

testFunction()

function userFunctions::testFunction

(

in

me

)

reset stimulus delay on time

Member Data Documentation

eT

Property userFunctions::eT

eyetracker manager

io

Property userFunctions::io

I/O manager.

rE

Property userFunctions::rE

runExperiment

rM

Property userFunctions::rM

reward manager

s

Property userFunctions::s

screenManager

sM

Property userFunctions::sM

stateMachine

stims

Property userFunctions::stims

metaStimulus stimluli

task

Property userFunctions::task

taskSequence

verbose

Property userFunctions::verbose

toggle to send messages to the command window

---

The documentation for this class was generated from the following file:

• userFunctions.m