Scripting Guide 1f: Experimental design: Protocols

 

Start a new protocol

For creating a stimulation protocol, a link to a possibly current stimulation protocol can be cleared via the command ClearStimulationProtocol().  

 

Give the protocol a name

The name of the protocol can be specified via the document property StimulationProtocolExperimentName.

 

Via the BrainVoyager user interface

Via scripting

 

Specify the time units

Via the BrainVoyager user interface

Via scripting

or

 

 

Add the conditions

 A condition can be added to the protocol via the AddCondition() command.

 

Via the BrainVoyager user interface

Via scripting

 

doc.AddCondition("SSLS");

 

Specify the intervals of the conditions

An interval can be added via the method doc.AddInterval("Objects_in_LVF", 35, 52);

 

Specify the colors of the conditions

Via the BrainVoyager user interface

Via scripting

 

To discriminate the different conditions, different colors can be used. The colors in BrainVoyager are specified as a combination of red, green and blue components, in this order. To lowest value for each component is 0 and the highest value is 255. When one of the components is set to 255 and the other two to 0, a primary color is obtained. When each of the components red, green and blue is set to 0, the result will be black in absence of all colors.

 

Color

Value red, green, blue

 

0, 0, 0

 

255, 255, 255

 

255, 0, 0

 

0, 255, 0

 

0, 0, 255

 

255, 255, 0

 

255, 0, 255

 

0, 255, 255

 

85, 0, 0

 

0, 85, 0

 

0, 0, 85

 

255, 85, 0

 

0, 85, 255

 

255, 0, 85

 

192, 192, 192

 

 

 A color for a condition can be set with the command doc.SetConditionColor("Objects in BVF", 0, 0, 255);

 

Stimulation protocol properties as defined via the Options dialog

Via the BrainVoyager user interface

Via scripting

 

 doc.StimulationProtocolBackgroundColorR = 0;

 doc.StimulationProtocolBackgroundColorG = 0;

 doc.StimulationProtocolBackgroundColorB = 0;

 

 doc.StimulationProtocolTimeCourseColorR = 255;

 doc.StimulationProtocolTimeCourseColorG = 255;

 doc.StimulationProtocolTimeCourseColorB = 255;

 

 doc.StimulationProtocolTimeCourseThickness = 4;

 

 

Saving

To save the protocol to disk, use the SaveStimulationProtocol() method.

 

Via the BrainVoyager user interface

Via scripting

            

To save the stimulation protocol link permanently in the FMR project, the doc.Save() method can be used.

 

  

 

Methods

ClearStimulationProtocol()

LinkStimulationProtocol()

AddCondition()

SetConditionColor()

AddInterval()

SaveStimulationProtocol()

 

Properties

StimulationProtocolFile: String

StimulationProtocolExperimentName: String

StimulationProtocolResolution: Number

StimulationProtocolBackgroundColorR: Number

StimulationProtocolBackgroundColorG: Number

StimulationProtocolBackgroundColorB: Number

StimulationProtocolTimeCourseColorR: Number

StimulationProtocolTimeCourseColorG: Number

StimulationProtocolTimeCourseColorB: Number

StimulationProtocolTextColorR: Number

StimulationProtocolTextColorG: Number

StimulationProtocolTextColorB: Number

StimulationProtocolTimeCourseThickness: Number