Overview

This is a Python wrapper for the BrainVoyager Scripting API.

It provides access to five built-in classes (without the need to import anything).

BrainVoyagerScriptAccess

The readily available object BrainVoyager is an instance of this class.

ActiveDocument

BrowseDirectory

x = BrainVoyager.BrowseDirectory(a)

a : str: the path (e.g. "./Desktop")
x : str: the selected directory

BrowseFile

x = BrainVoyager.BrowseFile(a, b)

a : str: the path (e.g. "./Desktop/")
b : str: a filemask (e.g. "*.txt")
x : str: the selcted file

BuildNumber

This is an int.

CallPluginFunction

x = BrainVoyager.CallPluginFunction(a)

a : str (?): the path (e.g. "./Desktop/")
x : bool: success (True or False)

CreateProjectAMR

x = BrainVoyager.CreateProjectAMR(a, b, c, d, e, f, g)

a : str: the filetype ("DICOM", "SIEMENS", "GE_I" (no parameters for +20 logic like in GUI), "GE_MR", "PHILIPS_REC" or "ANALYZE")
b : str: the full path to first file
c : int: the number of volumes
d : bool: swap byte order (True or False)
e : int: the size of the image along x-axis
f : int: the size of the image along y-axis
g : int: the number of bytes per pixel
x : DocumentScriptAccess: the document

CreateProjectDMR

x = BrainVoyager.CreateProjectDMR(a, b, c, d, e, f, g, h, i, j, k, l)

a : str: the filetype ("DICOM", "PHILIPS_REC" or "ANALYZE")
b : str: the full path to first file
c : int: the number of volumes
d : int: the number of volumes to skip
e : bool: create AMR (True or False)
f : int: the number of slices in a volume
g : str: the STC prefix
h : bool: swap byte order (True or False)
i : int: the size of the image along x-axis
j : int: the size of the image along y-axis
k : int: the number of bytes per pixel
l : str: the directory to save to
x : DocumentScriptAccess: The document

CreateProjectFMR

x = BrainVoyager.CreateProjectFMR(a, b, c, d, e, f, g, h, i, j, k, l)

a : str: the filetype ("DICOM", "SIEMENS", "GE_I" (no parameters for +20 logic like in GUI), "GE_MR", "PHILIPS_REC" or "ANALYZE")
b : str: the full path to first file
c : int: the number of volumes
d : int: the number of volumes to skip
e : bool: create AMR (True or False)
f : int: the number of slices in a volume
g : str: the STC prefix
h : bool: swap byte order (True or False)
i : int: the size of the image along x-axis
j : int: the size of the image along y-axis
k : int: the number of bytes per pixel
l : str: the directory to save to
x : DocumentScriptAccess: The document

CreateProjectFMRSlicesTimeLooping

x = BrainVoyager.CreateProjectFMRSlicesTimeLooping(a, b, c, d, e, f, g, h, i, j, k, l)

a : str: the filetype ("DICOM", "SIEMENS", "GE_I" (no parameters for +20 logic like in GUI), "GE_MR", "PHILIPS_REC" or "ANALYZE")
b : str: the full path to first file
c : int: the number of volumes
d : int: the number of volumes to skip
e : bool: create AMR (True or False)
f : int: the number of slices in a volume
g : str: the STC prefix
h : bool: swap byte order (True or False)
i : int: the size of the image along x-axis
j : int: the size of the image along y-axis
k : int: the number of bytes per pixel
l : str: the directory to save to
x : DocumentScriptAccess: The document

CreateProjectMosaicDMR

x = BrainVoyager.CreateProjectMosaicDMR(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)

a : str: the filetype ("DICOM", "SIEMENS", "GE_I" (no parameters for +20 logic like in GUI), "GE_MR", "PHILIPS_REC" or "ANALYZE")
b : str: the full path to first file
c : int: the number of volumes
d : int: the number of volumes to skip
e : bool: create AMR (True or False)
f : int: the number of slices in a volume
g : str: the STC prefix
h : bool: swap byte order (True or False)
i : int: the mosaic size of images in volume along x-axis
j : int: the mosaic size of the images in volume along y-axis
k : int: the number of bytes per pixel
l : str: the directory to save to
m : int: the number of volumes per image
n : int: the dimension of image along x-axis
o : int: the dimension of image along y-axis
x : DocumentScriptAccess: the document

CreateProjectMosaicFMR

x = BrainVoyager.CreateProjectMosaicFMR(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)

a : str: the filetype ("DICOM", "SIEMENS", "GE_I" (no parameters for +20 logic like in GUI), "GE_MR", "PHILIPS_REC" or "ANALYZE")
b : str: the full path to first file
c : int: the number of volumes
d : int: the number of volumes to skip
e : bool: create AMR (True or False)
f : int: the number of slices in a volume
g : str: the STC prefix
h : bool: swap byte order (True or False)
i : int: the mosaic size of images in volume along x-axis
j : int: the mosaic size of the images in volume along y-axis
k : int: the number of bytes per pixel
l : str: the directory to save to
m : int: the number of volumes per image
n : int: the dimension of image along x-axis
o : int: the dimension of image along y-axis
x : DocumentScriptAccess: the document

CreateProjectVMR

x = BrainVoyager.CreateProjectVMR(a, b, c, d, e, f, g)

a : str: the filetype ("DICOM", "SIEMENS", "GE_I" (no parameters for +20 logic like in GUI), "GE_MR", "PHILIPS_REC" or "ANALYZE")
b : str: the full path to first file
c : int: the number of volumes
d : bool: swap byte order (True or False)
e : int: the size of the image along x-axis
f : int: the size of the image along y-axis
g : int: the number of bytes per pixel
x : DocumentScriptAccess: the document

CurrentDirectory

This is a str.

Documents

This is a DocumentListScriptAccess.

ExecutePlugin

x = BrainVoyager.ExecutePlugin()

x : bool: success (True or False)

Exit

BrainVoyager.Exit()

FindChild

x = BrainVoyager.FindChild(a)

a : str: the widget name
x : QObject: QObject

GetPluginFloatParameter

x = BrainVoyager.GetPluginFloatParameter(a)

a : str: the parameter name
x : float: the parameter value

GetPluginIntParameter

x = BrainVoyager.GetPluginIntParameter(a)

a : str: the parameter name
x : int: the paramter value

GetPluginStringParameter

x = BrainVoyager.GetPluginStringParameter(a)

a : str: the parameter name
x : str: the parameter value

GetVTCsOfMDM

x = BrainVoyager.GetVTCsOfMDM(a)

a : str: the MDM filename
x : tuple: the VTCs

HideScriptsWindow

BrainVoyager.HideScriptsWindow()

Is64Bits

This is a bool.

MessageBox

BrainVoyager.MessageBox(a)

a : str: the message

MoveWindow

BrainVoyager.MoveWindow(a, b)

a : int: the new x position
b : int: the new y position

OpenDocument

x = BrainVoyager.OpenDocument(a)

a : int: the full path to file
x : DocumentScriptAccess: the document

PathToData

This is a str.

PathToSampleData

This is a str.

PrintToLog

BrainVoyager.PrintToLog(a)

a : str: the content to print

RenameDicomFilesInDirectory

BrainVoyager.RenameDicomFilesInDirectory(a)

a : str: the new name

ResizeWindow

BrainVoyager.ResizeWindow(a, b)

a : int: the new x size
b : int: the new y size

SetPluginFloatParameter

BrainVoyager.SetPluginFloatParameter(a, b)

a : str: the parameter name
b : float: the paramter value

SetPluginIntParameter

BrainVoyager.SetPluginIntParameter(a, b)

a : str: the parameter name
b : int: the paramter value

SetPluginStringParameter

BrainVoyager.SetPluginStringParameter(a, b)

a : str: the parameter name
b : str: the paramter value

ShowLogTab

BrainVoyager.ShowLogTab()

ShowScriptsWindow

BrainVoyager.ShowScriptsWindow()

TimeOutMessageBox

x = BrainVoyager.TimeOutMessageBox(a, b)

a : str: the message
b : int: the duration
x : bool: success (True or False)

VersionMajor

This is an int.

VersionMinor

This is an int.

VersionPatch

This is an int.

VOIFileName

This is a str.

blockSignals

x = BrainVoyager.blockSignals(a)

a : bool: True or False
x : bool: state before change (True or False)

childEvent

BrainVoyager.childEvent(a, b)

a : QChildEvent: ?
b : ?: ?

children

x = BrainVoyager.children()

x : tuple: ?

className

x = BrainVoyager.className()

x : str: 'BrainVoyagerScriptAccess'

connect

x = BrainVoyager.connect(a, b, c, d, e)

a : QObject (?): the sender
b : QByteArray (?): the signal
c : QObject (?): the receiver
d : QByteArray (?): the slot
e : Qt::ConnectionType (?): the connection type
x : bool: True or False

customEvent

BrainVoyager.customEvent(a, b)

a : QEvent: ?
b : ?: ?

delete

BrainVoyager.delete()

deleteLater

BrainVoyager.deleteLater()

destroyed

BrainVoyager.distroyed()

disconnect

x = BrainVoyager.disconnect(a, b, c, d)

a : QObject (?): the sender (?)
b : QByteArray (?): the signal (?)
c : QObject (?): the receiver (?)
d : QByteArray (?): the slot (?)
x : bool: True or False

dumpObjectInfo

BrainVoyager.dumpObjectInfo(a)

a : ?: ?

dumpObjectTree

BrainVoyager.dumpObjectTree(a)

a : ?: ?

dynamicPropertyNames

BrainVoyager.dynamicPropertyNames(a)

a : ?: ?

event

x = BrainVoyager.event(a)

a : QEvent (?): the event
x : bool: True or False

eventFilter

x = BrainVoyager.eventFilter(a, b)

a : QObject (?): ?
b : QEvent (?): the event
x : bool: True or False

findChild

x = BrainVoyager.findChild(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : QObject (?): the child

findChildren

x = BrainVoyager.findChildren(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : tuple: the children

h

This is an int.

help

BrainVoyager.help()

inherits

BrainVoyager.inherits()

installEventFilter

BrainVoyager.installEventFilter(a)

a : QObject (?): ?

isSignalConnected

x = BrainVoyager.isSignalConnected(a)

a : QMethodSignal (?): the signal
x : bool: True or False

isWidgetType

x = BrainVoyager.isWidgetType()

x : bool: True or False

isWindowType

x = BrainVoyager.isWindowType()

x : bool: True or False

killTimer

BrainVoyager.killTimer(a)

a : int: the id

metaObject

x = BrainVoyager.metaObject()

x : PythonQt.QtCore.QMetaObject (?): ?

moveToThread

BrainVoyager.moveToThread(a)

a : QThread: the thread

objectName

This is a str.

objectNameChanged

BrainVoyager.objectNameChanged(a)

a : str (?): ?

parent

x = BrainVoyager.parent()

x : QObject (?): ?

property

x = BrainVoyager.property(a)

a : str (?): the name
x : ?: ?

removeEventFilter

BrainVoyager.removeEventFilter(a)

a : QObject (?): ?

sender

BrainVoyager.sender()

x : QObject (?): ?

senderSignalIndex

BrainVoyager.senderSignalIndex()

x : int: the index

setObjectName

BrainVoyager.setObjectName(a)

a : str: the name

setParent

BrainVoyager.setParent(a)

a : QObject: the parent

setProperty

BrainVoyager.setProperty(a)

a : str (?): the property name
b : ?: the property value

signalsBlocked

x = BrainVoyager.signalsBlocked()

x : bool: True or False

startTimer

x = BrainVoyager.startTimer(a)

a : int: the interval
b : QT::TimeType (?): the timer type (?)
x : int: ?

thread

BrainVoyager.thread()

timerEvent

BrainVoyager.timerEvent(a)

a : QTimerEvent (?): ?

tr

x = BrainVoyager.tr(a, b, c)

a : QByteArray (?): ?
b : QByteArray (?): ?
c : int: ?
x : str: ?

value

This is an int.

visible

This is a bool.

w

This is an int.

x

This is an int.

y

This is an int.

DocumentScriptAccess

Opened AMR, DMR, FMR and VMR documents are instances of this class. For example: document = BrainVoyager.ActiveDocument.

AddCondition

document.AddCondition(a)

a : str: the condition name

AddContrast

document.AddContrast(a)

a : str: the contrast name

AddInterval

document.AddInterval(a, b, c)

a : str: the condition name
b : int: lower bound
c : int: upper bound

AddMesh

x = document.AddMesh(a)

a : str: the mesh file name
x : bool: success (True or False)

AddPredictor

document.AddPredictor(a)

a : str: the predictor name

AddROIContrast

document.AddROIContrast(a)

a : str: the contrast name
b : str: the contrast content

AddStudyAndDesignMatrix

document.AddStudyAndDesignMatrix(a, b)

a : str: the functional file name
b : str: the design matrix file name

AdjustMeanIntensity

x = document.AdjustMeanIntensity()

x : bool: success (True or False)

ApplyHemodynamicResponseFunctionToPredictor

document.ApplyHemodynamicResponseFunctionToPredictor(a)

a : str: the predictor name

AutoACPCAndTALTransformation

x = document.AutoACPCAndTALTransformation()

x : bool: success (True or False)

AutoTransformToIsoVoxel

x = document.AutoTransformToIsoVoxel(a, b)

a : int: the interpolation value
b : str: the ISO VMR file name
x : bool: success (True or False)

AutoTransformToSAG

x = document.AutoTransformToSAG(a)

a : str: the saggital VMR file name
x : bool: success (True or False)

ClearContrasts

document.ClearContrasts()

ClearDesignMatrix

document.ClearDesignMatrix()

ClearMultiStudyGLMDefinition

document.ClearMultiStudyGLMDefinition()

ClearStimulationProtocol

document.ClearStimulationProtocol()

Close

document.Close()

ComputeMultiStudyGLM

document.ComputeMultiStudyGLM()

ComputeRFXGLM

document.ComputeRFXGLM()

ComputeSingleStudyGLM

document.ComputeSingleStudyGLM()

ComputeSingleStudyGLMForVOI

document.ComputeSingleStudyGLMForVOI()

CoregisterFMRToVMR

x = document.CoregisterFMRToVMR(a, b)

a : str: the FMR file name
b : int: use original FMR volume (0), “pseudo” AMR (1; recommended), AMR (2)
x : bool: success

CoregisterFMRToVMRUsingBBR

x = document.CoregisterFMRToVMRUsingBBR(a)

a : str: the FMR file name
x : bool: success

CorrectForSerialCorrelations

This is an int.

CorrectIntensityInhomogeneities

x = document.CorrectIntensityInhomogeneities()

x : bool: success (True or False)

CorrectMotion

x = document.CorrectMotion(a)

a : int: the target volume
x : bool: success (True or False)

CorrectMotionEx

x = document.CorrectMotionEx(a, b, c, d, e, f)

a : int: the target volume
b : int: the interpolation method (0 and 1: trilinear detection and trilinear interpolation, 2: trilinear detection and sinc interpolation or 3: sinc detection of motion and sinc interpolation)
c : bool: use full data set (True or False)
d : int: the maximum number of iterations
e : bool: generate movies (True or False)
f : bool: generate extended log file (True or False)
x : bool: success (True or False)

CorrectMotionTargetVolumeInOtherRun

x = document.CorrectMotionTargetVolumeInOtherRun(a, b)

a : str: the target FMR file name
b : int: the target volume
x : bool: success (True or False)

CorrectMotionTargetVolumeInOtherRunEx

x = document.CorrectMotionTargetVolumeInOtherRunEx(a, b, c, d, e, f, g)

a : str: the target FMR file name
b : int: the target volume
c : int: the interpolation method (0 and 1: trilinear detection and trilinear interpolation, 2: trilinear detection and sinc interpolation or 3: sinc detection of motion and sinc interpolation)
d : bool: use full data set (True or False)
e : int: the maximum number of iterations
f : bool: generate movies (True or False)
g : bool: generate extended log file (True or False)
x : bool: success (True or False)

CorrectSliceTiming

x = document.CorrectSliceTiming(a, b)

a : str: the slice order (0: Ascending, 1: Ascending-interleaved, 2: Ascending-interleaved 2 (Siemens only), 10: Descending, 11: Descending-interleaved, 12: Descending-interleaved 2)
b : int: the interpolation method (0: trilinear, 1: cubic spline, 2: windowed SINC)
x : bool: success (True or False)

CorrectSliceTimingUsingTimeTable

x = document.CorrectSliceTimingUsingTimeTable(a)

a : int: the interpolation method (0: trilinear, 1: cubic spline, 2: windowed SINC)
x : bool: success (True or False)

CorrectSliceTimingWithSliceOrder

x = document.CorrectSliceTimingWithSliceOrder(a, b)

a : str: the slice number order (e.g. ““1 14 2 15 3 16”)
b : int: the interpolation method (0: trilinear, 1: cubic spline, 2: windowed SINC)
x : bool: success (True or False)

CreateMTCFromVTC

x = document.CreateMTCFromVTC(a, b, c)

a : float: the sampling depth inside white matter
b : float: the sampling depth inside grey matter
c : str: the resulting MTC file name
x : bool: success (True or False)

CreateVDWInACPCSpace

x = document.CreateVDWInACPCSpace(a, b, c, d, e, f, g, h, i)

a : str: the DMR file name
b : str: the IA file name
c : str: the FA file name
d : str: the ACPC file name
e : str: the resulting VDW file name
f : int: the data type (1: integer 2-byte format, 2: float format)
g : int: the resolution (1, 2 or 3; e.g. 1: 1 x 1 x 1 mm)
h : int: the interpolation method (0: nearest neighbor, 1: trilinear, 2: sinc)
i : int: the bounding box intensity threshold (default = 100)
x : bool: success (True or False)

CreateVDWInTALSpace

x = document.CreateVDWInTALSpace(a, b, c, d, e, f, g, h, i, j)

a : str: the DMR file name
b : str: the IA file name
c : str: the FA file name
d : str: the ACPC file name
e : str: the TAL file name
f : str: the resulting VDW file name
g : int: the data type (1: integer 2-byte format, 2: float format)
h : int: the resolution (1, 2 or 3; e.g. 1: 1 x 1 x 1 mm)
i : int: the interpolation method (0: nearest neighbor, 1: trilinear, 2: sinc)
j : int: the bounding box intensity threshold (default = 100)
x : bool: success (True or False)

CreateVDWInVMRSpace

x = document.CreateVDWInVMRSpace(a, b, c, d, e, f, g, h)

a : str: the DMR file name
b : str: the IA file name
c : str: the FA file name
d : str: the resulting VDW file name
e : int: the data type (1: integer 2-byte format, 2: float format)
f : int: the resolution (1, 2 or 3; e.g. 1: 1 x 1 x 1 mm)
g : int: the interpolation method (0: nearest neighbor, 1: trilinear, 2: sinc)
h : int: the bounding box intensity threshold (default = 100)
x : bool: success (True or False)

CreateVTC

x = document.CreateVTC(a, b, c, d, e, f)

a : str: the FMR file name
b : str: the IA file name
c : str: the FA file name
d : str: the ACPC file name
e : str: the TAL file name
f : str: the resulting VTC file name
x : bool: success (True or False)

CreateVTCInACPCSpace

x = document.CreateVTCInACPCSpace(a, b, c, d, e, f, g, h, i)

a : str: the FMR file name
b : str: the IA file name
c : str: the FA file name
d : str: the ACPC file name
e : str: the resulting VTC file name
f : int: the data type (1: integer 2-byte format, 2: float format)
g : int: the resolution (1, 2 or 3; e.g. 1: 1 x 1 x 1 mm)
h : int: the interpolation method (0: nearest neighbor, 1: trilinear, 2: sinc)
i : int: the bounding box intensity threshold (default = 100)
x : bool: success (True or False)

CreateVTCInMNISpace

x = document.CreateVTCInMNISpace(a, b, c, d, e, f, g, h, i)

a : str: the FMR file name
b : str: the IA file name
c : str: the FA file name
d : str: the TRF file name
e : str: the resulting VTC file name
f : int: the data type (1: integer 2-byte format, 2: float format)
g : int: the resolution (1, 2 or 3; e.g. 1: 1 x 1 x 1 mm)
h : int: the interpolation method (0: nearest neighbor, 1: trilinear, 2: sinc)
i : int: the bounding box intensity threshold (default = 100)
x : bool: success (True or False)

CreateVTCInTALSpace

x = document.CreateVTCInTALSpace(a, b, c, d, e, f, g, h, i, j)

a : str: the FMR file name
b : str: the IA file name
c : str: the FA file name
d : str: the ACPC file name
e : str: the TAL file name
f : str: the resulting VTC file name
g : int: the data type (1: integer 2-byte format, 2: float format)
h : int: the resolution (1, 2 or 3; e.g. 1: 1 x 1 x 1 mm)
i : int: the interpolation method (0: nearest neighbor, 1: trilinear, 2: sinc)
j : int: the bounding box intensity threshold (default = 100)
x : bool: success (True or False)

CreateVTCInVMRSpace

x = document.CreateVTCInVMRSpace(a, b, c, d, e, f, g, h)

a : str: the FMR file name
b : str: the IA file name
c : str: the FA file name
d : str: the resulting VTC file name
e : int: the data type (1: integer 2-byte format, 2: float format)
f : int: the resolution (1, 2 or 3; e.g. 1: 1 x 1 x 1 mm)
g : int: the interpolation method (0: nearest neighbor, 1: trilinear, 2: sinc)
h : int: the bounding box intensity threshold (default = 100)
x : bool: success (True or False)

CurrentMesh

This is a MeshScriptAccess.

DeselectVOI

document.DeselectVOI(a)

a : int: the VOI index

DimX

This is an int.

DimY

This is an int.

DimX

This is an int.

ExtendedTALSpaceForVTCCreation

This is a bool.

FileName

This is a str.

FileNameOfCurrentVTC

This is an str.

FileNameOfPreprocessdFMR

This is a str.

FirstConfoundPredictorOfSDM

This is an int.

GapThickness

This is a float.

GetBetaNameOfROIGLM

x = document.GetBetaNameOfROIGLM(a)

a : int: the beta index
x : str: the name

GetBetaValueOfROIGLM

x = document.GetBetaValueOfROIGLM(a)

a : int: the beta index
x : float: the value

GetFMRDataAsDoubleList

x = document.GetFMRDataAsDoubleList()

x : tuple: the FMR data as float values

GetMeshScene

x = document.GetMeshScene()

x : MeshSceneScriptAccess: the mesh scene

GetNameOfROIContrast

x = document.GetNameOfROIContrast(a)

a : int: the contrast index
x : str: the contrast name

GetNameOfVOI

x = document.GetNameOfVOI(a)

a : int: the VOI index
x : str: the VOI name

GetNameOfVolumeMap

x = document.GetNameOfVolumeMap(a)

a : int: the volume map index
x : str: the volume map name

GetPValueOfROIContrast

x = document.GetPValueOfROIContrast(a)

a : int: the contrast index
x : float: the p-value

GetTValueOfROIContrast

x = document.GetTValueOfROIContrast(a)

a : int: the contrast index
x : float: the t-value

GetVolumeDataAsByteBuffer

x = document.GetVolumeDataAsByteBuffer()

x : PythonQt.QtCore.QByteArray: the byte buffer

GetVolumeDataAsDoubleList

x = document.GetVolumeDataAsDoubleList()

x : tuple: the data as float values

GetVolumeDataAsIntList

x = document.GetVolumeDataAsIntList()

x : tuple: the data as integer values

GetVoxelIntensity

x = document.GetVoxelIntensity(a, b, c)

a : int: the x coordinate
b : int: the y coordinate
c : int: the z coordinate
x : int: the voxel intensity value

HasSliceTimeTable

This is a bool.

HideAllVOIs

document.HideAllVOIs()

HideVolumeMapsDlg

document.HideVolumeMapsDlg()

InterSliceTime

This is an int.

LinearTrendRemoval

x = document.LinearTrendRemoval()

x : bool: success (True or False)

LinkAMR

x = document.LinkAMR(a)

a : str: the AMR file name
x : bool: success (True or False)

LinkMTC

x = document.LinkMTC(a)

a : str: the MTC file name
x : bool: success (True or False)

LinkStimulationProtocol

x = document.LinkStimulationProtocol(a)

a : str: the protocol file name
x : bool: success (True or False)

LinkVTC

x = document.LinkVTC(a)

a : str: the VTC file name
x : bool: success (True or False)

LoadGLM

x = document.LoadGLM(a)

a : str: the GLM file name
x : bool: success (True or False)

LoadMesh

x = document.LoadMesh(a)

a : str: the Mesh file name
x : bool: success (True or False)

LoadMultiStudyGLMDefinitionFile

x = document.LoadMultiStudyGLMDefinitionFile(a)

a : str: the MDM file name
x : bool: success (True or False)

LoadSingleStudyGLMDesignMatrix

x = document.LoadSingleStudyGLMDesignMatrix(a)

a : str: the SDM file name
x : bool: success (True or False)

LoadVOIFile

x = document.LoadVOIFile(a)

a : str: the VOI file name
x : bool: success (True or False)

LoadVolumeMaps

x = document.LoadVolumeMaps(a)

a : str: the volume maps file name
x : bool: success (True or False)

MeshScene

This is a MeshSceneScriptAccess.

MotionCorrection3D

x = document.MotionCorrection3D()

x : bool: success (True or False)

NormalizeToMNISpace

document.NormalizeToMNISpace()

NrOfPredictorsInSingleStudyDM

This is an int.

NrOfROIContrasts

This is an int.

NrOfSkippedVolumes

This is an int.

NrOfSlices

This is an int.

NrOfTimePointsInSingleStudyDM

This is an int.

NrOfVOIs

This is an int.

NrOfVolumeMaps

This is an int.

NrOfVolumes

This is an int.

PSCTransformStudies

This is a bool.

PathFileName

This is a str.

PixelSizeOfSliceDimX

This is a float.

PixelSizeOfSliceDimY

This is a float.

PrepareROIContrasts

document.PrepareROIContrasts(a)

a : int: the number of predictors

Remove

document.Remove()

SDMContainsConstantPredictor

This is a bool.

Save

x = document.Save()

x : bool: success (True or False)

SaveAs

x = document.SaveAs(a)

a : str: the file name
x : bool: success (True or False)

SaveFMRAndSTCFromMem

x = document.SaveFMRAndSTCFromMem(a)

a : str: the file name
x : bool: success (True or False)

SaveGLM

document.SaveGLM(a)

a : str: the file name

SaveMesh

x = document.SaveMesh(a)

a : str: the file name
x : bool: success (True or False)

SaveMultiStudyGLMDefinitionFile

document.SaveMultiStudyGLMDefinitionFile(a)

a : str: the file name

SaveSingleStudyGLMDesignMatrix

document.SaveSingleStudyGLMDesignMatrix(a)

a : str: the file name

SaveSnapshotOfSurfaceWindow

x = document.SaveSnapshotOfSurfaceWindow(a)

a : str: the file name
x : bool: success (True or False)

SaveStimulationProtocol

document.SaveStimulationProtocol(a)

a : str: the file name

SaveVTC

x = document.SaveVTC(a)

a : str: the file name
x : bool: success (True or False)

SaveVolumeMaps

document.SaveVolumeMaps(a)

a : str: the file name

ScalePredictorValues

document.ScalePredictorValues(a, b, c)

a : str: the predictor name
b : float: the new maximum value
c : bool: scale only if values are positive (True or False)

SelectVOI

document.SelectVOI(a)

a : int: the VOI index

SeparationOfStudyPredictors

This is a bool.

SeparationOfSubjectPredictors

This is a bool.

SetConditionColor

document.SetConditionColor(a, b, c, d)

a : str: the condition name
b : int: the red colour level
c : int: the green colour level
d : int: the blue colour level

SetContrastString

document.SetContrastString(a)

a : str: the contrast string

SetContrastValue

document.SetContrastValue(a, b)

a : str: the predictor name
b : int: the contrast value

SetContrastValueAtIndex

document.SetContrastValueAtIndex(a, b)

a : int: the predictor index
b : int: the contrast value

SetCurrentContrast

document.SetCurrentContrast(a)

a : str: the contrast name

SetCurrentContrastAtIndex

document.SetCurrentContrastAtIndex(a)

a : int: the contrast index

SetPredictorValues

document.SetPredictorValues(a, b, c, d)

a : str: the predictor name
b : int: the interval start
c : int: the interval end
d : float: the predictor value

SetPredictorValuesFromCondition

document.SetPredictorValuesFromCondition(a, b, c)

a : str: the predictor name
c : str: the protocol condition name
d : float: the predictor value

SetVoxelIntensity

document.SetVoxelIntensity(a, b, c, d)

a : int: the x coordinate
b : int: the y coordinate
c : int: the z coordinate
d : int: the intensity value

ShowGLM

document.ShowGLM()

ShowSelectedVOIs

document.ShowSelectedVOIs()

ShowVolumeMap

document.ShowVolumeMap(a)

a : int: the volume map index

ShowVolumeMapsDlg

document.ShowVolumeMapsDlg()

SliceThickness

This is a float.

SliceTimeCorrection

x = document.SliceTimeCorrection(a)

a : int: the slice order (0: Ascending, 1: Ascending-interleaved, 2: Ascending-interleaved 2 (Siemens only), 10: Descending, 11: Descending-interleaved, 12: Descending-interleaved 2)
x : bool: success (True or False)

SpatialGaussianSmoothing

x = document.SpatialGaussianSmoothing(a, b)

a : float: the FWHM value
b : str: the FWHM value unit (“mm” or “px”)
x : bool: success (True or False)

StimulationProtocolBackgroundColorB

This is a int.

StimulationProtocolBackgroundColorG

This is a int.

StimulationProtocolBackgroundColorR

This is a int.

StimulationProtocolExperimentName

This is a str.

StimulationProtocolFile

This is a str.

StimulationProtocolResolution

This is an int.

StimulationProtocolTextColorB

This is an int.

StimulationProtocolTextColorG

This is an int.

StimulationProtocolTextColorR

This is an int.

StimulationProtocolTimeCourseColorB

This is an int.

StimulationProtocolTimeCourseColorG

This is an int.

StimulationProtocolTimeCourseColorR

This is an int.

StimulationProtocolTimeCourseThickness

This is an int.

TR

This is an int.

TargetVTCBoundingBoxXEnd

This is an int.

TargetVTCBoundingBoxXStart

This is an int.

TargetVTCBoundingBoxYEnd

This is an int.

TargetVTCBoundingBoxYStart

This is an int.

TargetVTCBoundingBoxZEnd

This is an int.

TargetVTCBoundingBoxZStart

This is an int.

TimeResolutionVerified

This is a bool.

TemporalGaussianSmoothing

x = document.TemporalGaussianSmoothing(a, b)

a : float: the FWHM value
b : str: the FWHM value unit (“mm” or “px”)
x : bool: success (True or False)

TemporalHighPassFilter

x = document.TemporalHighPassFilter(a, b)

a : float: the highpass value
b : str: the highpass value unit (“cycles” or “Hz”)
x : bool: success (True or False)

TemporalHighPassFilterGLMDCT

x = document.TemporalHighPassFilterGLMDCT(a)

a : int: the number of basis functions
x : bool: success (True or False)

TemporalHighPassFilterGLMFourier

x = document.TemporalHighPassFilterGLMFourier(a)

a : int: the number of cycles
x : bool: success (True or False)

UpdateSurfaceWindow

document.UpdateSurfaceWindow()

UpdateWindow

document.UpdateWindow(a)

a : bool (optional): process events (True or False)

UseBoundingBoxForVTCCreation

This is a bool.

VMRVoxelResolutionX

This is a float.

VMRVoxelResolutionY

This is a float.

VMRVoxelResolutionZ

This is a float.

VoxelResolutionVerified

This is a bool.

ZTransformStudies

This is a bool.

ZTransformStudiesBaselineOnly

This is a bool.

blockSignals

x = document.blockSignals(a)

a : bool: True or False
x : bool: state before change (True or False)

childEvent

document.childEvent(a, b)

a : QChildEvent: ?
b : ?: ?

children

x = document.children()

x : tuple: ?

className

x = document.className()

x : str: 'BrainVoyagerScriptAccess'

connect

x = document.connect(a, b, c, d, e)

a : QObject (?): the sender
b : QByteArray (?): the signal
c : QObject (?): the receiver
d : QByteArray (?): the slot
e : Qt::ConnectionType (?): the connection type
x : bool: True or False

customEvent

document.customEvent(a, b)

a : QEvent: ?
b : ?: ?

delete

document.delete()

deleteLater

document.deleteLater()

destroyed

document.distroyed()

disconnect

x = document.disconnect(a, b, c, d)

a : QObject (?): the sender (?)
b : QByteArray (?): the signal (?)
c : QObject (?): the receiver (?)
d : QByteArray (?): the slot (?)
x : bool: True or False

dumpObjectInfo

document.dumpObjectInfo(a)

a : ?: ?

dumpObjectTree

document.dumpObjectTree(a)

a : ?: ?

dynamicPropertyNames

document.dynamicPropertyNames(a)

a : ?: ?

event

x = document.event(a)

a : QEvent (?): the event
x : bool: True or False

eventFilter

x = document.eventFilter(a, b)

a : QObject (?): ?
b : QEvent (?): the event
x : bool: True or False

findChild

x = document.findChild(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : QObject (?): the child

findChildren

x = document.findChildren(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : tuple: the children

help

document.help()

inherits

document.inherits()

installEventFilter

document.installEventFilter(a)

a : QObject (?): ?

isSignalConnected

x = document.isSignalConnected(a)

a : QMethodSignal (?): the signal
x : bool: True or False

isWidgetType

x = document.isWidgetType()

x : bool: True or False

isWindowType

x = document.isWindowType()

x : bool: True or False

killTimer

document.killTimer(a)

a : int: the id

metaObject

x = document.metaObject()

x : PythonQt.QtCore.QMetaObject (?): ?

moveToThread

document.moveToThread(a)

a : QThread: the thread

objectName

This is a str.

objectNameChanged

document.objectNameChanged(a)

a : str (?): ?

parent

x = document.parent()

x : QObject (?): ?

property

x = document.property(a)

a : str (?): the name
x : ?: ?

removeEventFilter

document.removeEventFilter(a)

a : QObject (?): ?

sender

document.sender()

x : QObject (?): ?

senderSignalIndex

document.senderSignalIndex()

x : int: the index

setObjectName

document.setObjectName(a)

a : str: the name

setParent

document.setParent(a)

a : QObject: the parent

setProperty

document.setProperty(a)

a : str (?): the property name
b : ?: the property value

signalsBlocked

x = document.signalsBlocked()

x : bool: True or False

startTimer

x = document.startTimer(a)

a : int: the interval
b : QT::TimeType (?): the timer type (?)
x : int: ?

thread

document.thread()

timerEvent

document.timerEvent(a)

a : QTimerEvent (?): ?

tr

x = document.tr(a, b, c)

a : QByteArray (?): ?
b : QByteArray (?): ?
c : int: ?
x : str: ?

vmp_dims

x = document.vmp_dims()

x : tuple: ?

DocumentListScriptAccess

For example, `document_list = document_list..

Count

This is an int.

Item

x = document_list.Item(a)

a : int: the index
x : DocumentScriptAccess: the document

Size

x = document_list.Size()

x : int: the number of documents

blockSignals

x = document_list.blockSignals(a)

a : bool: True or False
x : bool: state before change (True or False)

childEvent

document_list.childEvent(a, b)

a : QChildEvent: ?
b : ?: ?

children

x = document_list.children()

x : tuple: ?

className

x = document_list.className()

x : str: 'DocumentListScriptAccess'

connect

x = document_list.connect(a, b, c, d, e)

a : QObject (?): the sender
b : QByteArray (?): the signal
c : QObject (?): the receiver
d : QByteArray (?): the slot
e : Qt::ConnectionType (?): the connection type
x : bool: True or False

customEvent

document_list.customEvent(a, b)

a : QEvent: ?
b : ?: ?

delete

document_list.delete()

deleteLater

document_list.deleteLater()

destroyed

document_list.distroyed()

disconnect

x = document_list.disconnect(a, b, c, d)

a : QObject (?): the sender (?)
b : QByteArray (?): the signal (?)
c : QObject (?): the receiver (?)
d : QByteArray (?): the slot (?)
x : bool: True or False

dumpObjectInfo

document_list.dumpObjectInfo(a)

a : ?: ?

dumpObjectTree

document_list.dumpObjectTree(a)

a : ?: ?

dynamicPropertyNames

document_list.dynamicPropertyNames(a)

a : ?: ?

event

x = document_list.event(a)

a : QEvent (?): the event
x : bool: True or False

eventFilter

x = document_list.eventFilter(a, b)

a : QObject (?): ?
b : QEvent (?): the event
x : bool: True or False

findChild

x = document_list.findChild(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : QObject (?): the child

findChildren

x = document_list.findChildren(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : tuple: the children

help

document_list.help()

inherits

document_list.inherits()

installEventFilter

document_list.installEventFilter(a)

a : QObject (?): ?

isSignalConnected

x = document_list.isSignalConnected(a)

a : QMethodSignal (?): the signal
x : bool: True or False

isWidgetType

x = document_list.isWidgetType()

x : bool: True or False

isWindowType

x = document_list.isWindowType()

x : bool: True or False

killTimer

document_list.killTimer(a)

a : int: the id

metaObject

x = document_list.metaObject()

x : PythonQt.QtCore.QMetaObject (?): ?

moveToThread

document_list.moveToThread(a)

a : QThread: the thread

objectName

This is a str.

objectNameChanged

document_list.objectNameChanged(a)

a : str (?): ?

parent

x = document_list.parent()

x : QObject (?): ?

property

x = document_list.property(a)

a : str (?): the name
x : ?: ?

removeEventFilter

document_list.removeEventFilter(a)

a : QObject (?): ?

sender

document_list.sender()

x : QObject (?): ?

senderSignalIndex

document_list.senderSignalIndex()

x : int: the index

setObjectName

document_list.setObjectName(a)

a : str: the name

setParent

document_list.setParent(a)

a : QObject: the parent

setProperty

document_list.setProperty(a)

a : str (?): the property name
b : ?: the property value

signalsBlocked

x = document_list.signalsBlocked()

x : bool: True or False

startTimer

x = document_list.startTimer(a)

a : int: the interval
b : QT::TimeType (?): the timer type (?)
x : int: ?

thread

document_list.thread()

timerEvent

document_list.timerEvent(a)

a : QTimerEvent (?): ?

tr

x = document_list.tr(a, b, c)

a : QByteArray (?): ?
b : QByteArray (?): ?
c : int: ?
x : str: ?

MeshScriptAccess

For example, mesh = BrainVoyager.ActiveDocument.CurrentMesh.

AddStudyAndDesignMatrixAndCortexMapping

mesh.AddStudyAndDesignMatrixAndCortexMapping(a, b, c)

a : str: the functional file name
b : str: the design matrix file name
c : str: the SSM file name

CalculateCurvature

mesh.CalculateCurvature()

CalculateCurvatureCBA

mesh.CalculateCurvatureCBA()

ClearDesignMatrix

mesh.ClearDesignMatrix()

ClearMultiStudyGLMDefinition

mesh.ClearMultiStudyGLMDefinition()

ComputeMultiStudyGLM

mesh.ComputeMultiStudyGLM()

ComputeRFXGLM

mesh.ComputeRFXGLM()

ComputeSingleStudyGLM

mesh.ComputeSingleStudyGLM()

CorrectForSerialCorrelations

This is an int.

CorrectInflatedSphereMesh

x = mesh.CorrectInflatedSphereMesh(a)

a : int: the number of cycles
x : bool: success (True or False)

CreateMTCFromVTC

x = mesh.CreateMTCFromVTC(a, b, c)

a : float: the starting normal position
b : float: the ending normal position
c : str: the resulting MTC file name
x : bool: success (True or False)

CreateMultiScaleCurvatureMap

x = mesh.CreateMultiScaleCurvatureMap(a, b, c, d)

a : int: the first smoothing level
b : int: the second smooting level
c : int: the third smoothing level
d : int: the fourth smoothing level
x : str: the file name (?)

CreateSphericalCoordinatesMapFromSMP

x = mesh.CreateSphericalCoordinatesMapFromSMP(a)

a : str: the SMP on sphere file name
x : str: the file name (?)

FileName

This is a str.

FileNameOfPreprocessdMTC

This is a str.

GetNameOfSurfaceMap

x = mesh.GetNameOfSurfaceMap(a)

a : int: the index
x : str: the name

InflateMesh

x = mesh.InflateMesh(a, b, c)

a : int: the number of cycles
b : float: the smoothing force
c : str: the area reference mesh
x : bool: success (True or False)

InflateMeshToSphere

x = mesh.InflateMeshToSphere(a)

a : int: the number of cycles
x : bool: success (True or False)

LinearTrendRemoval

x = mesh.LinearTrendRemoval()

x : bool: success (True or False)

LinkMTC

x = mesh.LinkMTC(a)

a : str: the MTC file name
x : bool: success (True or False)

LoadGLM

x = mesh.LoadGLM(a)

a : str: the file name
x : bool: success (True or False)

LoadMultiStudyGLMDefinitionFile

x = mesh.LoadMultiStudyGLMDefinitionFile(a)

a : str: the file name
x : bool: success (True or False)

LoadSingleStudyGLMDesignMatrix

x = mesh.LoadSingleStudyGLMDesignMatrix(a)

a : str: the file name
x : bool: success (True or False)

LoadSurfaceMaps

x = mesh.LoadSurfaceMaps(a)

a : str: the file name
x : bool: success (True or False)

MeshScene

This is a MeshSceneScriptAccess

MorphingUpdateInterval

This is an int.

NrOfMTCVolumes

This is an int.

NrOfSurfaceMaps

This is an int.

NrOfVertices

This is an int.

Save

mesh.Save()

SaveAs

mesh.SaveAs(a)

a : str: the file name

SaveGLM

mesh.SaveGLM(a)

a : str: the file name

SaveMTC

mesh.SaveMTC(a)

a : str: the file name

SaveMultiStudyGLMDefinitionFile

mesh.SaveMultiStudyGLMDefinitionFile(a)

a : str: the file name

SaveSingleStudyGLMDesignMatrix

mesh.SaveSingleStudyGLMDesignMatrix(a)

a : str: the file name

SaveSurfaceMaps

mesh.SaveSurfaceMaps(a)

a : str: the file name

ShowGLM

mesh.ShowGLM()

ShowSurfaceMap

mesh.ShowSurfaceMap(a)

a : int: the index

SimplifyMesh

x = mesh.SimplifyMesh(a)

a : int: the number of target vertices
x : str: the file name (?)

SmoothCurrentMap

mesh.SmoothCurrentMap(a)

a : int: the number of cycles

SmoothMesh

x = mesh.SmoothMesh(a, b)

a : int: the number of cycles
b : float: the smoothing force
x : bool: success (True or False)

SmoothRecoMesh

x = mesh.SmoothRecoMesh(a, b)

a : int: the number of cycles
b : float: the smoothing force
x : bool: success (True or False)

SpatialSmoothing

x = mesh.SpatialSmoothing(a)

a : int: the number of cycles
x : bool: success (True or False)

TemporalGaussianSmoothing

x = mesh.TemporalGaussianSmoothing(a, b)

a : float: the FWHM value
b : str: the unit of the FWHM value (“mm” or “px”)
x : bool: success (True or False)

TemporalHighPassFilterFFT

x = mesh.TemporalHighPassFilterFFT(a)

a : int: the number of cycles in time course
x : bool: success (True or False)

UpdateAppearance

mesh.UpdateAppearance(a)

a : bool: process events (True or False)

blockSignals

x = mesh.blockSignals(a)

a : bool: True or False
x : bool: state before change (True or False)

childEvent

mesh.childEvent(a, b)

a : QChildEvent: ?
b : ?: ?

children

x = mesh.children()

x : tuple: ?

className

x = mesh.className()

x : str: 'MeshScriptAccess'

connect

x = mesh.connect(a, b, c, d, e)

a : QObject (?): the sender
b : QByteArray (?): the signal
c : QObject (?): the receiver
d : QByteArray (?): the slot
e : Qt::ConnectionType (?): the connection type
x : bool: True or False

customEvent

mesh.customEvent(a, b)

a : QEvent: ?
b : ?: ?

delete

mesh.delete()

deleteLater

mesh.deleteLater()

destroyed

mesh.distroyed()

disconnect

x = mesh.disconnect(a, b, c, d)

a : QObject (?): the sender (?)
b : QByteArray (?): the signal (?)
c : QObject (?): the receiver (?)
d : QByteArray (?): the slot (?)
x : bool: True or False

dumpObjectInfo

mesh.dumpObjectInfo(a)

a : ?: ?

dumpObjectTree

mesh.dumpObjectTree(a)

a : ?: ?

dynamicPropertyNames

mesh.dynamicPropertyNames(a)

a : ?: ?

event

x = mesh.event(a)

a : QEvent (?): the event
x : bool: True or False

eventFilter

x = mesh.eventFilter(a, b)

a : QObject (?): ?
b : QEvent (?): the event
x : bool: True or False

findChild

x = mesh.findChild(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : QObject (?): the child

findChildren

x = mesh.findChildren(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : tuple: the children

help

mesh.help()

inherits

mesh.inherits()

installEventFilter

mesh.installEventFilter(a)

a : QObject (?): ?

isSignalConnected

x = mesh.isSignalConnected(a)

a : QMethodSignal (?): the signal
x : bool: True or False

isWidgetType

x = mesh.isWidgetType()

x : bool: True or False

isWindowType

x = mesh.isWindowType()

x : bool: True or False

killTimer

mesh.killTimer(a)

a : int: the id

metaObject

x = mesh.metaObject()

x : PythonQt.QtCore.QMetaObject (?): ?

moveToThread

mesh.moveToThread(a)

a : QThread: the thread

objectName

This is a str.

objectNameChanged

mesh.objectNameChanged(a)

a : str (?): ?

parent

x = mesh.parent()

x : QObject (?): ?

property

x = mesh.property(a)

a : str (?): the name
x : ?: ?

removeEventFilter

mesh.removeEventFilter(a)

a : QObject (?): ?

sender

mesh.sender()

x : QObject (?): ?

senderSignalIndex

mesh.senderSignalIndex()

x : int: the index

setObjectName

mesh.setObjectName(a)

a : str: the name

setParent

mesh.setParent(a)

a : QObject: the parent

setProperty

mesh.setProperty(a)

a : str (?): the property name
b : ?: the property value

signalsBlocked

x = mesh.signalsBlocked()

x : bool: True or False

startTimer

x = mesh.startTimer(a)

a : int: the interval
b : QT::TimeType (?): the timer type (?)
x : int: ?

thread

mesh.thread()

timerEvent

mesh.timerEvent(a)

a : QTimerEvent (?): ?

tr

x = mesh.tr(a, b, c)

a : QByteArray (?): ?
b : QByteArray (?): ?
c : int: ?
x : str: ?

MeshSceneScriptAccess

For example: mesh_scene = BrainVoyager.ActiveDocument.MeshScene.

AddCurvatureFileForGroupCBA

x = mesh_scene.AddCurvatureFileForGroupCBA(a)

a : str: the curvature SMP file name
x : bool: success (True or False)

AddMesh

x = mesh_scene.AddMesh(a)

a : str: the file name
x : bool: success (True or False)

ClearGroupCBACurvatureFiles

mesh_scene.ClearGroupCBACurvatureFiles()

Count

This is an int.

CreateAverageCurvatureGroupMap

x = mesh_scene.CreateAverageCurvatureGroupMap()

x : bool: success (True or False)

CreateAverageFoldedGroupMesh

x = mesh_scene.CreateAverageFoldedGroupMesh()

x : bool: success (True or False)

CreateStandardSphereMesh

x = mesh_scene.CreateStandardSphereMesh()

x : str: the full path file SRF name

CurrentMesh

This is a MeshScriptAccess.

Item

x = mesh_scene.Item(a)

a : int: the index
x : MeshSceneScriptAccess: the item

LoadMesh

x = mesh_scene.LoadMesh(a)

a : str: the file name
x : bool: success (True or False)

MapSphereMeshFromStandardSphere

x = mesh_scene.MapSphereMeshFromStandardSphere()

x : str: the full path SSM file name

MergeMeshesInScene

x = mesh_scene.MergeMeshesInScene()

x : str: the full path SRF file name

RunCBA

x = mesh_scene.RunCBA()

x : bool: success (True or False)

RunRigidCBA

x = mesh_scene.RunRigidCBA(a)

a : str: the target PMP file name
x : bool: success (True or False)

SaveSnapshotOfSurfaceWindow

x = mesh_scene.SaveSnapshotOfSurfaceWindow()

x : bool: success (True or False)

SetStandardSphereToFoldedMesh

x = mesh_scene.SetStandardSphereToFoldedMesh(a)

a : str: the folded mesh file name
x : str: the full path SRF file name

SphereResolutionCBA

This is an int.

UpdateSurfaceWindow

mesh_scene.UpdateSurfaceWindow(a)

a : bool (optional): process events (True or False)

ViewpointPositionX

This is a float.

ViewpointPositionY

This is a float.

ViewpointPositionZ

This is a float.

ViewpointRotationY

This is a float.

ViewpointRotationX

This is a float.

ViewpointRotationZ

This is a float.

blockSignals

x = mesh_scene.blockSignals(a)

a : bool: True or False
x : bool: state before change (True or False)

childEvent

mesh_scene.childEvent(a, b)

a : QChildEvent: ?
b : ?: ?

children

x = mesh_scene.children()

x : tuple: ?

className

x = mesh_scene.className()

x : str: 'MeshSceneScriptAccess'

connect

x = mesh_scene.connect(a, b, c, d, e)

a : QObject (?): the sender
b : QByteArray (?): the signal
c : QObject (?): the receiver
d : QByteArray (?): the slot
e : Qt::ConnectionType (?): the connection type
x : bool: True or False

customEvent

mesh_scene.customEvent(a, b)

a : QEvent: ?
b : ?: ?

delete

mesh_scene.delete()

deleteLater

mesh_scene.deleteLater()

destroyed

mesh_scene.distroyed()

disconnect

x = mesh_scene.disconnect(a, b, c, d)

a : QObject (?): the sender (?)
b : QByteArray (?): the signal (?)
c : QObject (?): the receiver (?)
d : QByteArray (?): the slot (?)
x : bool: True or False

dumpObjectInfo

mesh_scene.dumpObjectInfo(a)

a : ?: ?

dumpObjectTree

mesh_scene.dumpObjectTree(a)

a : ?: ?

dynamicPropertyNames

mesh_scene.dynamicPropertyNames(a)

a : ?: ?

event

x = mesh_scene.event(a)

a : QEvent (?): the event
x : bool: True or False

eventFilter

x = mesh_scene.eventFilter(a, b)

a : QObject (?): ?
b : QEvent (?): the event
x : bool: True or False

findChild

x = mesh_scene.findChild(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : QObject (?): the child

findChildren

x = mesh_scene.findChildren(a, b)

a : PyObject (?): ?
b : str: the name (?)
x : tuple: the children

help

mesh_scene.help()

inherits

mesh_scene.inherits()

installEventFilter

mesh_scene.installEventFilter(a)

a : QObject (?): ?

isSignalConnected

x = mesh_scene.isSignalConnected(a)

a : QMethodSignal (?): the signal
x : bool: True or False

isWidgetType

x = mesh_scene.isWidgetType()

x : bool: True or False

isWindowType

x = mesh_scene.isWindowType()

x : bool: True or False

killTimer

mesh_scene.killTimer(a)

a : int: the id

metaObject

x = mesh_scene.metaObject()

x : PythonQt.QtCore.QMetaObject (?): ?

moveToThread

mesh_scene.moveToThread(a)

a : QThread: the thread

objectName

This is a str.

objectNameChanged

mesh_scene.objectNameChanged(a)

a : str (?): ?

parent

x = mesh_scene.parent()

x : QObject (?): ?

property

x = mesh_scene.property(a)

a : str (?): the name
x : ?: ?

removeEventFilter

mesh_scene.removeEventFilter(a)

a : QObject (?): ?

sender

mesh_scene.sender()

x : QObject (?): ?

senderSignalIndex

mesh_scene.senderSignalIndex()

x : int: the index

setObjectName

mesh_scene.setObjectName(a)

a : str: the name

setParent

mesh_scene.setParent(a)

a : QObject: the parent

setProperty

mesh_scene.setProperty(a)

a : str (?): the property name
b : ?: the property value

signalsBlocked

x = mesh_scene.signalsBlocked()

x : bool: True or False

startTimer

x = mesh_scene.startTimer(a)

a : int: the interval
b : QT::TimeType (?): the timer type (?)
x : int: ?

thread

mesh_scene.thread()

timerEvent

mesh_scene.timerEvent(a)

a : QTimerEvent (?): ?

tr

x = mesh_scene.tr(a, b, c)

a : QByteArray (?): ?
b : QByteArray (?): ?
c : int: ?
x : str: ?

Script Access

Overview

BrainVoyagerScriptAccess

ActiveDocument

BrowseDirectory

BrowseFile

BuildNumber

CallPluginFunction

CreateProjectAMR

CreateProjectDMR

CreateProjectFMR

CreateProjectFMRSlicesTimeLooping

CreateProjectMosaicDMR

CreateProjectMosaicFMR

CreateProjectVMR

CurrentDirectory

Documents

ExecutePlugin

Exit

FindChild

GetPluginFloatParameter

GetPluginIntParameter

GetPluginStringParameter

GetVTCsOfMDM

HideScriptsWindow

Is64Bits

MessageBox

MoveWindow

OpenDocument

PathToData

PathToSampleData

PrintToLog

RenameDicomFilesInDirectory

ResizeWindow

SetPluginFloatParameter

SetPluginIntParameter

SetPluginStringParameter

ShowLogTab

ShowScriptsWindow

TimeOutMessageBox

VersionMajor

VersionMinor

VersionPatch

VOIFileName

blockSignals

childEvent

children

className

connect

customEvent

delete

deleteLater

destroyed

disconnect

dumpObjectInfo

dumpObjectTree

dynamicPropertyNames

event

eventFilter

findChild

findChildren

h

help

inherits

installEventFilter

isSignalConnected

isWidgetType

isWindowType

killTimer

metaObject

moveToThread

objectName

objectNameChanged

parent

property

removeEventFilter

sender

senderSignalIndex

setObjectName

setParent