magstimManager Class Reference

magstimManager - controls a MagStim Rapid TMS system using a LabJack More...

Detailed Description

magstimManager - controls a MagStim Rapid TMS system using a LabJack

Connects to and manages a TMS stimulator using a LabJack U3 / U6.

‍mM = magstimManager() create magstim manager object mM.open connect via a LabJack mM.stimulate % run a stimulation protocol

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

Inheritance diagram for magstimManager:

Public Member Functions
function	magstimManager (in varargin)
	Delete method.
function	open (in obj)
	Delete method.
function	close (in obj)
	Delete method.
function	delete (in obj)
	Delete method.
function	stimulate (in obj)
	Delete method.
Public Member Functions inherited from optickaCore
function	optickaCore (in varargin)
	Class constructor.
function get	fullName (in me)
function	getALF (in me, in subject, in sessionPrefix, in lab, in create)
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)
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	initialiseGlobals (in me, in doReset, in doOpen)
function	initialiseSaveFile (in me)
	Initialise Save prefix.
function	checkPaths (in me)
	checks the paths are valid

Public Attributes
Property	defaultTTL
	which FIO line to use for the MagStim
Property	silentMode
	silentMode allows one to gracefully fail methods without a dataPixx connected
Property	lJ
	labJack to use
Property	stimulateTime
	time to stimulate
Property	frequency
	frequency to stimulate at
Property	rewardTime
	time of reward
Property	verbose
	verbose or not
Property	isOpen
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	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
Static Public Member Functions inherited from optickaCore
static function	makeArgs (in args)
	Converts cell args to structure array.
static function	addDefaults (in args, in defs)
	add 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.
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

magstimManager()

function magstimManager::magstimManager

(

in

varargin

)

Delete method.

Member Function Documentation

close()

function magstimManager::close

(

in

obj

)

Delete method.

delete()

function magstimManager::delete

(

in

obj

)

Delete method.

open()

function magstimManager::open

(

in

obj

)

Delete method.

stimulate()

function magstimManager::stimulate

(

in

obj

)

Delete method.

Member Data Documentation

defaultTTL

Property magstimManager::defaultTTL

which FIO line to use for the MagStim

frequency

Property magstimManager::frequency

frequency to stimulate at

isOpen

Property magstimManager::isOpen

lJ

Property magstimManager::lJ

labJack to use

rewardTime

Property magstimManager::rewardTime

time of reward

silentMode

Property magstimManager::silentMode

silentMode allows one to gracefully fail methods without a dataPixx connected

stimulateTime

Property magstimManager::stimulateTime

time to stimulate

verbose

Property magstimManager::verbose

verbose or not

---

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

• communication/magstimManager.m