Overview of BrainVoyager QX scripting and plugin functions

 

The current list describes which functions there are specifically for BrainVoyager QX.

All other Qt Script for Application (QSA) functions, that are available via the BrainVoyager QX scripting editor, are reported in Chapter 2c of the BrainVoyager QX scripting guide. A description of the BrainVoyager QX plugin access functions is available in the chapter 'Plugins' of the BrainVoyager QX User's Guide, which is also visible online via http://www.brainvoyager.com/bvqx/doc/UsersGuide/FlashHelp/BrainVoyagerQXUsersGuide.htm

 

The following scripting and plugin access functions are available in BrainVoyager QX 1.9:

 

 

File

type

Description of function

Scripting

Since

QX

Plugins

Since

QX

 

 

 

 

 

 

FMR

Create project from raw data

CreateProjectFMR()

CreateProjectMosaicFMR()

CreateProjectFMRSlicesTimeLooping()

1.0,

1.0,

1.6

 

 

 

Link AMR

LinkAMR()

1.6

 

 

 

Link PRT

LinkStimulationProtocol()

1.3

 

 

 

Get header information

TR (property)

InterSliceTime (property)

NrOfVolumes (property)

PixelSizeOfSliceDimX (property)

PixelSizeOfSliceDimY (property)

InterSliceTime (property)

SliceThickness  (property)

GapThickness  (property)

VoxelResolutionVerified (property)

TimeResolutionVerified (property)

FileNameOfPreprocessdFMR (property)

1.0

qxGetHeaderOfCurrentFMR()

qxSetHeaderOfCurrentFMR()

qxGetSTCDataOfCurrentFMR()

 

1.9

 

Slice time correction

CorrectSliceTiming()

1.5

 

 

 

Motion correction and intra session alignment

CorrectMotion()

CorrectMotionEx()

CorrectMotionTargetVolumeInOtherRun()

CorrectMotionTargetVolumeInOtherRunEx()

1.0,

1.2

 

 

 

Low pass filter/smooth

TemporalGaussianSmoothing()

SpatialGaussianSmoothing

1.0

 

 

 

High pass filter

TemporalHighPassFilter()

LinearTrendRemoval()

1.0

 

 

 

Save

Save()

SaveAs()

 

qxSaveFMR()

qxSaveFMRAndSTC()

1.9

VMR

Create project from raw data

CreateProjectVMR()

1.0

 

 

 

Isovoxelate

AutoTransformToIsovoxel()

1.6

 

 

 

Transform to sagittal orientation

AutoTransformToSag()

1.6

 

 

 

Get header information

TR (property)

InterSliceTime (property)

NrOfVolumes (property)

PixelSizeOfSliceDimX (property)

PixelSizeOfSliceDimY (property)

InterSliceTime (property)

SliceThickness (property)

GapThickness (property)

VoxelResolutionVerified (property)

TimeResolutionVerified (property)

1.0

qxGetMainHeaderOfCurrentVMR()

qxSetMainHeaderOfCurrentVMR()

qxGetScannerPositionHeaderOfCurrentVMR()

qxSetScannerPositionHeaderOfCurrentVMR()

qxGetPastTransformationsHeaderOfCurrentVMR()

qxSetPastTransformationsHeaderOfCurrentVMR()

qxReframeCurrentVMR()

 

 

Get data

GetVoxelIntensity()

SetVoxelIntensity()

1.0

qxGetCurrentVMR()

1.3.8

 

Get cross position

 

 

qxGetCrossPositionOfCurrentVMR()

1.4.2

 

Save project

Save()

SaveAs()

1.0

 

 

DMR/DWI

 

CreateProjectDMR()

CreateProjectMosaicDMR()

1.9

qxSetHeaderOfCurrentDMR()

qxGetDWIDataOfCurrentDMR()

qxConvertDWIFormatOfCurrentDMR()

1.9

 

Save

Save()

SaveAs()

 

qxSaveDMR()

qxSaveDMRAndDWI()

1.9

MSK

Load mask

 

 

qxLoadMaskToCurrentVMR()

1.3.8

 

Get data of mask

 

 

qxGetMask()

1.3.8

AMR

Create project from raw data

CreateProjectAMR()

1.0

 

 

VTC

Link VTC to current VMR

LinkVTC()

1.2

qxLinkVTCToCurrentVMR()

1.4.2

 

Create (space for) VTC

CreateVTCInVMRSpace()

CreateVTCInACPCSpace()

CreateVTCInTALSpace()

ExtendedTALSpaceForVTCCreation (property)

1.3

 

 

1.8

qxCreateVTCForCurrentVMR()

qxClearMultiVTCAnalysis()

 

1.4.2

1.9

 

Get VTC data

 

 

qxGetVTCOfCurrentVMR()

qxAddVTCRefForMultiVTCAnalysis()

qxGetVoxelTimeCourseOfVTC()

qxGetVoxelTimeCourseOfVTCs()

qxGetVoxelCoordsTimeCourseOfVTC()

qxGetVoxelCoordsTimeCourseOfVTCs()

1.3.8

1.9

 

Change VTC header

 

 

qxSetVTCParametersOfCurrentVMR()

1.3.8

 

Save VTC file

 

 

qxSaveVTCOfCurrentVMR()

1.4.2

MTC

Link MTC to current SRF

 

 

qxLinkMTCToCurrentSRF()

1.5.4

 

 

 

 

qxGetMTCOfCurrentSRF()

1.5.4

 

 

 

 

qxSetMTCParametersOfCurrentSRF()

1.5.4

 

 

 

 

qxCreateMTCOfCurrentSRF()

1.5.4

 

 

 

 

qxSaveMTCOfCurrentSRF()

1.5.4

PRT

Create new protocol

ClearStimulationProtocol()

1.3

 

 

 

Add condition

AddCondition()

1.3

 

 

 

Get header information

StimulationProtocolFile (property)

StimulationProtocolExperimentName (property)

StimulationProtocolResolution (property)

StimulationProtocolBackgroundColorR/G/B (properties)

StimulationProtocolTimeCourseColorR/G/B (properties)

StimulationProtocolTextColorR/G/B (properties)

StimulationProtocolTimeCourseThickness (property)

1.3

qxGetProtocol()

1.4.2

 

Get condition-specific information

 

 

qxGetProtocolCondition()

1.4.2

 

Set color of condition

SetConditionColor()

1.3

 

 

 

Add interval

AddInterval()

1.3

 

 

 

Save stimulation protocol

SaveStimulationProtocol()

1.3

 

 

RTC

Create new design matrix

ClearDesignMatrix()

1.3

qxClearDesignMatrix()

1.4.2

 

Add predictor

AddPredictor()

AutoAddConstantPredictor()

1.3

qxAddPredictor()

1.4.2

 

Set predictor values

SetPredictorValues()

SetPredictorValuesFromCondition()

ScalePredictorValues()

1.3

qxSetPredictorValuesFromCondition()

qxSetPredictorValuesFromConditionName()

1.4.2

 

Apply HRF to condition

ApplyHemodynamicResponseFunctionToPredictor()

 

1.3

qxApplyTwoGammaHRFToPredictor()

qxApplyTwoGammaHRFToPredictorWithName()

qxApplyBoyntonHRFToPredictor()

qxApplyBoyntonHRFToPredictorWithName()

1.4.8,

1.4.8,

1.4.2,

1.4.2

 

Get predictor values

 

 

qxGetPredictor()

qxGetPredictorByName()

1.4.2

 

Load design matrix

LoadSingleStudyGLMDesignMatrix()

1.3

qxLoadSingleStudyGLMDesignMatrix()

1.4.2

 

Save design matrix

SaveSingleStudyGLMDesignMatrix()

1.3

qxSaveSingleStudyGLMDesignMatrix()

1.4.2

MDM

Create new design matrix

ClearMultiStudyGLMDefinition()

1.3

 

 

 

Add FMR/VTC and RTC

AddStudyAndDesignMatrix()

1.3

 

 

 

Load MDM

LoadMultiStudyGLMDefinitionFile()

1.3

 

 

 

Save MDM

SaveMultiStudyGLMDefinitionFile()

1.3

 

 

VOI

Get VOI header

 

 

qxGetVOIs()

1.4.2

 

Get coordinates of one VOI

 

 

qxGetVOI()

 

VMP

Load VMP

 

 

qxLoadVMPsToCurrentVMR() *

1.3.8

 

Get VMP header

 

 

qxGetVMPsOfCurrentVMR() *

1.4.2

 

Get VMP map data

 

 

qxGetVMPOfCurrentVMR() *

1.3.8

 

Change VMP header

 

 

qxSetVMPParametersOfCurrentVMR() *

1.3.8

 

Save VMP file

 

 

qxSaveVMPsOfCurrentVMR() *

1.3.8

 

Create VMP file

 

 

qxCreateVMPForCurrentVMR() *

1.3.8

NR-VMP

 

 

 

qxGetNRVMPOfCurrentVMR()

qxLoadNRVMPsToCurrentVMR()

qxSaveNRVMPsOfCurrentVMR()

qxCreateNRVMPsForCurrentVMR()

qxDeleteNRVMPsOfCurrentVMR()

qxSetNRVMPsParamsDisplayRange()

1.9

AR-VMP

 

 

 

qxGetARVMPsOfCurrentVMR()

qxGetARVMPOfCurrentVMR()

qxSetARVMPParametersOfCurrentVMR()

qxLoadARVMPsToCurrentVMR()

qxSaveARVMPsOfCurrentVMR()

qxCreateARVMPForCurrentVMR()

qxDeleteARVMPsOfCurrentVMR()

1.9

SMP

Get SMP header

 

 

qxGetSMPsOfCurrentSRF()

1.5.4

 

Change SMP header

 

 

qxSetSMPParametersOfCurrentSRF()

1.5.4

 

Load SMP

 

 

qxLoadSMPsToCurrentSRF()

1.5.4

 

Create SMP map

 

 

qxCreateSMPForCurrentSRF()

1.5.4

 

Delete SMP 

 

 

qxDeleteSMPsOfCurrentSRF()

1.5.4

 

Reload SMP  

 

 

qxOverlaySMPsOnSRF()

1.5.4

GLM

Load GLM

LoadGLM()

1.3

 

 

 

Get GLM

 

 

qxGetGLMOfCurrentVMR()

1.8

 

Show GLM

ShowGLM()

1.3

 

 

 

Set GLM parameters

CorrectForSerialCorrelations (property)

ZtransformStudies (property)

ZtransformStudiesBaselineOnly (property)

PSCTransformStudies (property)

SeparationOfStudyPredictors (property)

SeparationOfSubjectPredictors (property)

1.3

 

 

 

Compute GLM

ComputeSingleStudyGLM()

ComputeMultiStudyGLM()

ComputeRFXGLM()

1.3

 

 

 

Save GLM

SaveGLM()

1.3

 

 

CTR

Clear constrasts

ClearContrasts()

1.3

 

 

 

Add contrast

AddContrast()

1.3

 

 

 

Select contrast to change

SetCurrentContrast()

SetCurrentContrastIndex()

1.3

 

 

 

Set contrast(s)

SetContrastString()

SetContrastValue()

SetContrastValueAtIndex()

1.3

 

 

CMP

Get CMP header

 

 

qxGetCMPsOfCurrentVMR() *

1.5.6

 

Get CMP map

 

 

qxGetCMPOfCurrentVMR() *

1.5.6

 

Change CMP header

 

 

qxSetCMPParametersOfCurrentVMR() *

1.5.6

 

Load CMP

 

 

qxLoadCMPsToCurrentVMR() *

1.5.6

 

Save CMP

 

 

qxSaveCMPsOfCurrentVMR() *

1.5.6

 

Create CMP

 

 

qxCreateCMPsForCurrentVMR() *

1.5.6

 

Delete CMP

 

 

qxDeleteCMPsForCurrentVMR() *

1.5.6

SRF

Get all SRFs

 

 

qxGetScene()

1.5.4

 

Get SRF header and data

 

 

qxGetCurrentSRF()

1.5.4

 

Change SRF parameters

 

 

qxSetCurrentSRF()

1.5.4

 

Save SRF file

SaveMesh()

1.2

qxSaveCurrentSRF()

1.5.4

 

Load SRF file

LoadMesh()

1.2

 

 

 

Add SRF file

AddMesh()

1.2

 

 

VWP

Change viewpoint settings

ViewpointTranslationX (property)

ViewpointTranslationY (property)

ViewpointTranslationZ (property)

ViewpointRotationX (property)

ViewpointRotationY (property)

ViewpointRotationZ (property)

1.2

 

 

(General)

Get BrainVoyager QX version

 

 

qxGetVersionOfBrainVoyagerQX()

1.4.8

 

Get BrainVoyager QX path

 

 

qxGetBrainVoyagerQXPath()

1.4.8

 

Get plugins path

 

 

qxGetPluginsPath()

1.4.8

 

Update active window

 

 

qxUpdateActiveWindow()

1.3.8

 

Update surface window

UpdateSurfaceWindow()

 

 

 

 

Make snapshot of surface window

SaveSnapshotOfSurfaceWindow()

 

 

 

 

Show BrainVoyager QX log tab

ShowLogTab()

1.4

qxShowLogTab()

1.4.2

 

Send text to log tab

PrintToLog()

1.4

qxLogText()

1.4.2

 

Move BrainVoyager QX window

MoveWindow()

1.0

 

 

 

Select active project

ActiveDocument()

1.0

 

 

 

Open project (FMR, VMR, AMR)

OpenDocument()

1.0

 

 

 

Close project (FMR, VMR, AMR)

Close()

1.0

 

 

 

Set current directory

SetCurrentDirectory()

1.0

 

 

 

Show busy cursor

 

 

qxShowBusyCursor()

1.4.2

 

Stop busy cursor

 

 

qxStopBusyCursor()

1.4.2

(User

interface)

Show message box

MessageBox()

1.0

qxMessageBox()

1.3.8

 

Show time out message box

TimeOutMessageBox()

1.0

 

 

 

Show input box (text)

Input.getText()

Input.getItem()

1.0

qxGetTextInput()

1.3.8

 

Show input box (integer)

Input.getNumber()

1.0

qxGetIntegerInput()

1.3.8

 

Show input box (float)

Input.getNumber()

1.0

qxGetFloatInput()

1.3.8

 

Create custom dialog

new Dialog;

1.0

 

 

 

Add components to dialog

add()

1.0

 

 

 

Launch dialog

exec()

1.0

 

 

 

Customized dialogs

see chapter 2c: graphical components

 

qxLaunchICADialog()

qxGetDlgStringParameter()

qxGetDlgIntegerParameter()

qxGetDlgFloatParameter()

 

 

* The VMP and CMP methods are obsolete in 1.9 and replaced by NR-VMP (native resolution VMP) and AR-VMP (anatomical resolution VMP) methods (see above).