behaviouralRecord Class Reference

Create a GUI and update performance plots for a behavioural task. More...

Detailed Description

Create a GUI and update performance plots for a behavioural task.

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

Inheritance diagram for behaviouralRecord:

Public Member Functions
function	behaviouralRecord (in varargin)
	Class constructor.
function	plotPerformance (in me)
function	createPlot (in me, in eL)
function	updatePlot (in me, in rE)
	updates the behaviouralRecord details, use plot() to draw it
function	plotAsync (in me, in drawNow)
function	plot (in me, in drawNow)
function	reset (in me)
function	clearHandles (in me)
Public Member Functions inherited from optickaCore
function	optickaCore (in varargin)
	Class constructor.
function get	fullName (in me)
function	getALF (in me, in subject, in lab, in create)
	get the ALF path
function	makeReport (in me, in rpt)
	Generate a detailed report for the opticka object.
function	findAttributes (in me, in attrName, in attrValue)
function	findAttributesandType (in me, in attrName, in attrValue, in type)
	find properties of object with specific attributes, for example all properties whose GetAcccess attribute is public and type is logical.
function	findPropertyDefault (in me, in propName)
	Return the declared default value for a class property.
function	clone (in me)
	Use this syntax to make a deep copy of the object, i.e. OBJ_OUT has the same field values, but will not behave as a handle-copy of me anymore.
function	checkSuperclasses (in List)
function	editProperties (in me, in properties)
	method to modify a set of properties
function	setProp (in me, in property, in value)
	method to fast change a particular value. This is useful for use in anonymous functions, like in the state machine.
function	initialiseSaveFile (in me, in varargin)
	just get date fragment for backwards compatibility
function	checkPaths (in me)
	checks the paths are valid

Static Public Member Functions
static function	loadobj (in in)
	loadobj To be backwards compatible to older saved protocols, we have to parse structures / objects specifically during object load
Static Public Member Functions inherited from optickaCore
static function	initialiseGlobals (in doReset, in doOpen)
static function	makeArgs (in args)
	Converts cell args to structure array.
static function	addDefaults (in args, in defs)
	regularises and adds default options to arg input
static function	hasKey (in in, in key)
	check if a struct / object has a propery / field
static function	getKeys (in device)
	PTB Get key presses, stops key bouncing.

Public Attributes
Property	silentMode
	silent mode which disables the plotting
Property	verbose
	verbosity
Property	response
Property	rt1
Property	rt2
Property	date
Property	info
Property	xAll
Property	yAll
Property	pupilAll
Property	correctStateName
Property	correctStateValue
Property	breakStateName
Property	breakStateValue
Property	rewardTime
Property	rewardVolume
Property	trials
Property	tick
Property	isOpen
Property	startTime
Property	radius
Property	time
Property	inittime
Property	average
Property	averages
Property	h
	handles for the GUI
Public Attributes inherited from optickaCore
Property	name
	object name
Property	comment
	comment
Property	verbose
	verbose logging, subclasses must assign this. This is normally logical true/false
Property	optickaVersion
	version number
Property	dateStamp
	clock() dateStamp set on construction
Property	uuid
	universal ID
Property	paths
	storage of various paths
Property	fullName
	The fullName is the object name combined with its uuid and class name.

Additional Inherited Members
Protected Member Functions inherited from optickaCore
function	parseArgs (in me, in args, in allowedProperties)
	Sets properties from a structure or normal arguments pairs, ignores invalid or non-allowed properties.
function	addArgs (in me, in args)
function	setPaths (in me)
	Sets properties from a structure or normal arguments pairs, ignores invalid or non-allowed properties.
function	getFonts (in me)
	set paths for object
function	toStructure (in me)
	Converts properties to a structure.
function	getType (in me, in in)
function	logOutput (in me, in in, in message, in override)
	Give a metaproperty return the likely property class.
function	salutation (in me, in varargin)
	Prints messages dependent on verbosity.
Protected Attributes inherited from optickaCore
Property	cloning
	are we cloning this from another object
Property	mversion
	Matlab version number, this is transient so it is not saved.
Property	sansFont
	sans font
Property	monoFont
	monoFont
Property	className
	class name
Property	savePrefix
	save prefix generated from clock time
Property	fullName_
	cached full name

Constructor & Destructor Documentation

behaviouralRecord()

function behaviouralRecord::behaviouralRecord

(

in

varargin

)

Class constructor.

More detailed description of what the constructor does.

Parameters

args	are passed as a structure of properties which is parsed.

Returns

instance of class.

Member Function Documentation

clearHandles()

function behaviouralRecord::clearHandles

(

in

me

)

createPlot()

function behaviouralRecord::createPlot	(	in	me,
		in	eL
	)

loadobj()

static function behaviouralRecord::loadobj ( in  in )

static

loadobj To be backwards compatible to older saved protocols, we have to parse structures / objects specifically during object load

Parameters

in	input object/structure

plot()

function behaviouralRecord::plot	(	in	me,
		in	drawNow
	)

plotAsync()

function behaviouralRecord::plotAsync	(	in	me,
		in	drawNow
	)

plotPerformance()

function behaviouralRecord::plotPerformance

(

in

me

)

reset()

function behaviouralRecord::reset

(

in

me

)

updatePlot()

behaviouralRecord::updatePlot	(	in	me,
		in	rE
	)

updates the behaviouralRecord details, use plot() to draw it

Parameters

rE	runExperiment object

Member Data Documentation

average

Property behaviouralRecord::average

averages

Property behaviouralRecord::averages

breakStateName

Property behaviouralRecord::breakStateName

breakStateValue

Property behaviouralRecord::breakStateValue

correctStateName

Property behaviouralRecord::correctStateName

correctStateValue

Property behaviouralRecord::correctStateValue

date

Property behaviouralRecord::date

h

Property behaviouralRecord::h

handles for the GUI

info

Property behaviouralRecord::info

inittime

Property behaviouralRecord::inittime

isOpen

Property behaviouralRecord::isOpen

pupilAll

Property behaviouralRecord::pupilAll

radius

Property behaviouralRecord::radius

response

Property behaviouralRecord::response

rewardTime

Property behaviouralRecord::rewardTime

rewardVolume

Property behaviouralRecord::rewardVolume

rt1

Property behaviouralRecord::rt1

rt2

Property behaviouralRecord::rt2

silentMode

Property behaviouralRecord::silentMode

silent mode which disables the plotting

startTime

Property behaviouralRecord::startTime

tick

Property behaviouralRecord::tick

time

Property behaviouralRecord::time

trials

Property behaviouralRecord::trials

verbose

Property behaviouralRecord::verbose

verbosity

xAll

Property behaviouralRecord::xAll

yAll

Property behaviouralRecord::yAll

---

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

• data/behaviouralRecord.m