opxOnline Provides an interface between Opticka and the Plexon for online data display More...

Detailed Description

opxOnline Provides an interface between Opticka and the Plexon for online data display

Inheritance diagram for opxOnline:

Public Member Functions
function	opxOnline (in args)
	Class constructor.

function	listenMaster (in obj)
	listenMaster

function	listenSlave (in obj)

function	parseData (in obj)
	parseData – The main loop the master runs to load data saved by slave and then plot it lazily

function	collectData (in obj)
	Main slave loop to collect and save spikes from the Onmiplex.

function	plot (in obj)
	plot is a shortcut function for commandline use

function	plotData (in obj)
	plotData is the main plotting function This takes our parseOpxSpikes data structure which is collected with parseData and plots it, either for all points (replotFlag==1) or just for the last trial that ran during a collection loop

function	selectIndex (in inIdx)
	Plots PSTH (inline function of plotData)

function	plotPSTH (in inRun)
	Plots PSTH (inline function of plotData)

function	plotCurve ()
	Plots Curve (inline function of plotData)

function	plotDensity ()
	Plots Curve (inline function of plotData)

function	convertToHz (in inn)
	Converts to spikes per second (inline function of plotData)

function	checkPlexonValues (in obj)
	plot is a shortcut function for commandline use

function	initializePlot (in obj, in type)
	Initialize the Plot before data collection starts This sets up the plot UI with the cell (type='all') and/or stimulus (type='stimulus') parameters.

function	setCellValues ()
	makes cell list for UI (inline function of initializePlot)

function	setStimulusValues ()
	sets UI values for stimulus (inline function of initializePlot)

function	saveData (in obj, in type)
	Saves a reduced set of our object as a structure, passing 'spikes' reduces the data transmitted even further.

function	openPlexon (in obj)

function	closePlexon (in obj)

function	closeAll (in obj)
	CloseAll closes all possible connections.

Static Public Member Functions
static function	loadobj (in in)
	load object method

static function	saveobj (in in)
	save object method

Public Attributes
Property	type
	type is either launcher, master or slave

Property	eventStart
	event marker used by Plexon SDK; 257 is any strobed event

Property	eventEnd
	event marker to denote trial end; 2047 is the maximum strobe number we can generate

Property	maxWait
	time to wait between trials by the slave

Property	autoRun

Property	protocol

Property	rAddress

Property	rPort

Property	lAddress

Property	lPort

Property	pollTime

Property	verbosity

Property	cleanup

Property	replotFlag
	should we replot all data in the ui?

Property	plotOptions
	struct containing several plot options

Property	saveDirectory
	the directory to save completed runs

Constructor & Destructor Documentation

◆ opxOnline()

function opxOnline::opxOnline ( in args )

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

◆ checkPlexonValues()

function opxOnline::checkPlexonValues ( in obj )

plot is a shortcut function for commandline use

◆ closeAll()

function opxOnline::closeAll ( in obj )

CloseAll closes all possible connections.

◆ closePlexon()

function opxOnline::closePlexon ( in obj )

◆ collectData()

function opxOnline::collectData ( in obj )

Main slave loop to collect and save spikes from the Onmiplex.

◆ convertToHz()

function opxOnline::convertToHz ( in inn )

Converts to spikes per second (inline function of plotData)

◆ initializePlot()

function opxOnline::initializePlot	(	in	obj,
		in	type
	)

Initialize the Plot before data collection starts This sets up the plot UI with the cell (type='all') and/or stimulus (type='stimulus') parameters.

Parameters

type	Configure all or just the stimulus parameter

◆ listenMaster()

function opxOnline::listenMaster ( in obj )

listenMaster

◆ listenSlave()

function opxOnline::listenSlave ( in obj )

◆ loadobj()

static function opxOnline::loadobj ( in in )

static

load object method

◆ openPlexon()

function opxOnline::openPlexon ( in obj )

◆ parseData()

function opxOnline::parseData ( in obj )

parseData – The main loop the master runs to load data saved by slave and then plot it lazily

◆ plot()

function opxOnline::plot ( in obj )

plot is a shortcut function for commandline use

◆ plotCurve()

function opxOnline::plotCurve ( )

Plots Curve (inline function of plotData)

◆ plotData()

function opxOnline::plotData ( in obj )

plotData is the main plotting function This takes our parseOpxSpikes data structure which is collected with parseData and plots it, either for all points (replotFlag==1) or just for the last trial that ran during a collection loop

◆ plotDensity()

function opxOnline::plotDensity ( )

Plots Curve (inline function of plotData)

◆ plotPSTH()

function opxOnline::plotPSTH ( in inRun )

Plots PSTH (inline function of plotData)

◆ saveData()

function opxOnline::saveData	(	in	obj,
		in	type
	)

Saves a reduced set of our object as a structure, passing 'spikes' reduces the data transmitted even further.

◆ saveobj()

static function opxOnline::saveobj ( in in )

static

save object method

◆ selectIndex()

function opxOnline::selectIndex ( in inIdx )

Plots PSTH (inline function of plotData)

◆ setCellValues()

function opxOnline::setCellValues ( )

makes cell list for UI (inline function of initializePlot)

◆ setStimulusValues()

function opxOnline::setStimulusValues ( )

sets UI values for stimulus (inline function of initializePlot)

Member Data Documentation

◆ autoRun

Property opxOnline::autoRun

◆ cleanup

Property opxOnline::cleanup

sometimes we shouldn't cleanup connections on delete, e.g. when we pass this object to another matlab instance as we will close the wrong connections!!!

◆ eventEnd

Property opxOnline::eventEnd

event marker to denote trial end; 2047 is the maximum strobe number we can generate

◆ eventStart

Property opxOnline::eventStart

event marker used by Plexon SDK; 257 is any strobed event

◆ lAddress

Property opxOnline::lAddress

◆ lPort

Property opxOnline::lPort

◆ maxWait

Property opxOnline::maxWait

time to wait between trials by the slave

◆ plotOptions

Property opxOnline::plotOptions

struct containing several plot options

◆ pollTime

Property opxOnline::pollTime

◆ protocol

Property opxOnline::protocol

◆ rAddress

Property opxOnline::rAddress

◆ replotFlag

Property opxOnline::replotFlag

should we replot all data in the ui?

◆ rPort

Property opxOnline::rPort

◆ saveDirectory

Property opxOnline::saveDirectory

the directory to save completed runs

◆ type

Property opxOnline::type

type is either launcher, master or slave

◆ verbosity

Property opxOnline::verbosity

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

omniplex/opxOnline.m