MasterScan  Lab_Matlab_control Master Branch
List of all members | Methods
topsTaskHelperReadable Class Reference
Inheritance diagram for topsTaskHelperReadable:
Inheritance graph
[legend]

Methods

self topsTaskHelperReadable (varargin)
 Class topsTaskHelperReadable. More...
 
 startTrial (self, varargin)
 % startTrial
 
 finishTrial (self, varargin)
 % finishTrial
 
eventName readEvent (self, acceptedEvents, task, eventTag)
 % readEvent More...
 
 setGazeParameters (self, windowSize, windowDuration)
 % Set gaze parameters More...
 
- Methods inherited from topsTaskHelper
self topsTaskHelper (varargin)
 Specs to use when looking for a copy. More...
 
theObject parse (self, name, fevalable, settings, commonSettings, unmatched)
 Parse constructor specs to make theObject – possibly recursive if making multiple objects and putting them into an ensemble. More...
 
 start (self, treeNode)
 start More...
 
 finish (self, treeNode)
 finish More...
 
 startTrial (self, treeNode)
 Function to prepare for use, called before each trial. More...
 
 finishTrial (self, treeNode)
 Finish trial method – should overload in subclass if needed.
 
 setProperty (self, varargin)
 Set property. More...
 
synchronizedTime getSynchronizedTime (self, unSynchronizedTime, useScreen)
 % getSyncronizedTime More...
 
 saveSynchronizedTime (self, unSynchronizedTime, useScreen, task, eventTag)
 % saveSyncronizedTime More...
 
- Methods inherited from topsFoundation
self topsFoundation (name)
 Constuct with name optional. More...
 
fig gui (self)
 Open a GUI to view object details. More...
 
guiPanel (self, varargin)
 Make a topsDetailPanel with details about this object. More...
 

Additional Inherited Members

- Properties and Events inherited from topsTaskHelper
Property theObject
 Class topsTaskHelper. More...
 
Property removeCopy = true
 Flag to remove copy from treeNode (see start)
 
Property ensembleObjectNames
 Keep track of the names of the objects in the ensemble.
 
Property ensembleObjectClasses
 Keep track of the classes of objects in the ensemble.
 
 sync
 For time synchronization.
 
 topsBindings
 Below are properties used to bind the helper to a topsTreeNode Defaults are defined in the constructor method.
 
- Properties and Events inherited from topsFoundation
Property name = ''
 a string name to indentify the object
 
Property clockFunction =@topsClock
 clock function, to standardize
 
- Protected Methods inherited from topsTaskHelper
 callFevalables (self, fevalables)
 Utility to call a list of fevalables.
 
- Static Methods inherited from topsTaskHelper
static synchronizationData getSynchronizationData (helperName, varargin)
 Get synchroniztion data from the current topsDataLog and make a maxtrix with columns: referenceTime offset. More...
 
static helpers makeHelpers (constructor, varargin)
 Utility to make helpers. More...
 
- Static Methods inherited from topsFoundation
static c index cellAdd (c, item, index)
 Add an item to a cell array. More...
 
static selector cellContains (c, item)
 Does a cell array conatin an item? More...
 
static c cellRemoveItem (c, item)
 Remove an item from a cell array. More...
 
static c cellRemoveElement (c, index)
 Remove indexed elements from a cell array. More...
 
static index selector findStructName (s, name)
 Where is the given name in the given struct array? More...
 

Constructor

◆ topsTaskHelperReadable()

self topsTaskHelperReadable ( varargin  )

Class topsTaskHelperReadable.

Add topsTaskHelperReadable, a subclass of topsTaskHelper Constuct the helper Arguments: just the ones passed to topsTaskHelper

Methods

◆ readEvent()

eventName readEvent ( self  ,
acceptedEvents  ,
task  ,
eventTag   
)

% readEvent

Useful utility for checking for an event and, if found, saving the (synchronized) timing of the event in the trial data struture. Arguments: acceptedEvents ... cell array of strings acceptedEvents to list names of events that can be used. task ... the topsTreeNode task caller eventTag ... string used to store timing information in trial struct. Assumes that the current trialData struct has an entry called time_<eventTag>.

◆ setGazeParameters()

setGazeParameters ( self  ,
windowSize  ,
windowDuration   
)

% Set gaze parameters

Utility for dotsReadableEye objects: set default gaze window size and duration


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