Table of Contents
Interfaces
- Application
interface
Application offers possibilities to create projects in BrainVoyager
- Collection
interface
Collection
- Document
The Document
interface contains all properties and methods of objects of a FMR/VMR/AMR
project (=document)
Functions
- Application::ActiveDocument
Retrieves
a reference to the active document of the accessed BrainVoyager instance.
- Application::CreateProjectAMR
Creates an
AMR project file.
- Application::CreateProjectFMR
Creates a
FMR project file.
- Application::CreateProjectMosaicFMR
Creates a
FMR project file from Mosaic data.
- Application::CreateProjectVMR
Creates a
VMR project file.
- Application::Documents
Provides access
to all projects within an instance of BrainVoyager.
- Application::Exit
Terminates
BrainVoyager.
- Application::GetCurrentFolder
Determines
the folder where BrainVoyager currently looks for files.
- Application::GetTime
GetTime()
provides a time value in milliseconds.
- Application::NewDocument
Create new
document
- Application::NewMainWindowPosition
Changes the
position of the BrainVoyager window on screen.
- Application::NewMainWindowSize
Changes the
width and height of the BrainVoyager window on screen.
- Application::OpenDocument
Opens a BrainVoyager
project file.
- Application::PrepareDemoGSGStep
- Application::ScriptLaunchedByBV
Determines
of running script was launched by BrainVoyager or from outside, ie.
- Application::Sleep
Stops running
BrainVoyager for a specified amount of milliseconds.
- Collection::Count
Count number
of items in collection
- Collection::Item
- Collection::_NewEnum
Return an
enumeration
- Document::AddCondition
Adds a condition
to a stimulation protocol
- Document::AddInterval
Add an interval
to a stimulation protocol.
- Document::AddMesh
Reads a surface
mesh file and adds it to the Surface Module window of the referenced VMR
document.
- Document::AddPredictor
Adds a predictor
to a design matrix Example: 'docAddPredictor "RVF"'
- Document::AddStudyAndDesignMatrix
Add subject
study and design matrix to multi study, multi subject GLM
- Document::ApplyHemodynamicResponseFunctionToPredictor
Apply the
hemodynamic response function to a predictor in a design matrix Example:
'docApplyHemodynamicResponseFunctionToPredictor "RVF"'
- Document::BeginRecordingSurfaceWindowMovie
Starts recording
every updated view in the Surface Module window and saves it to a movie
file.
- Document::ClearContrast
Clear contrast
in design matrix
- Document::ClearDesignMatrix
Create a design
matrix.
- Document::ClearMultiStudyGLMDefinition
Clear/create
multi study, multi subject GLM to specify study x predictor interaction
effects
- Document::ClearStimulationProtocol
Used to start
a new stimulation protocol;
- Document::Close
Closes a BrainVoyager
project file.
- Document::CloseAllTimeCoursePlots
Closes all
previously created time course windows.
- Document::CloseTimeCoursePlot
Closes a previously
created time course window.
- Document::ComputeMultiStudyGLM
Run the multi
study, multi subject GLM
- Document::ComputeSingleStudyGLM
Run the single
study GLM
- Document::ConvertFuncToAMR
Converts the
first functional volume of an FMR project into an AMR file.
- Document::CorrectMotion
Detects and
corrects rigid-body motion within an FMR file.
- Document::CorrectMotionTargetVolumeInOtherRun
Detects and
corrects rigid-body motion within several runs.
- Document::CreateSphereMesh
Creates a
new spherical mesh which can be used to reconstruct the skin of a subject's
head by iterative morphing.
- Document::CreateVTC
Transforms
the time course data of an FMR project into a defined 3D space, typically
Talairach space.
- Document::DeselectAllPredictors
Deselects
all predictors of a multiple regression (GLM) result allowing to start
a new predictor selection process.
- Document::EnableTwoSetPredictorColours
A flag is
set to show the relative contribution of the combined variance explained
by two sets of predictors in a multiple regression (GLM).
- Document::EnableTwoSetPredictorContrast
Sets the status
of a flag to show the contrast between two sets of predictors in a multiple
regression (GLM).
- Document::EndRecordingSurfaceWindowMovie
Stops recording
Surface Module window movie and closes the movie file.
- Document::FileNameOfPreprocessdFMR
Property of
preprocessed fmr-project, generated by BrainVoyager; non-preprocessed
fmr-project still exists
-
GapThickness:
- Document::GetVoxelIntensity
Gets the voxel
intensity of the voxel specified by the coordinates
- Document::Hide3DVolumeTools
Hides the
3D Volume Tools dialog.
- Document::InflateMesh
Unfolds the
sulci of a folded mesh representing the cortical sheet of a hemisphere.
- Document::InterSliceTime
Gets or set
InterSliceTime of fmr-project
- Document::LinearTrendRemoval
Remove linear
drifts from the data
- Document::LinearTrendRemovalEx
Remove linear
drifts from the data - extended version
- Document::LinkAMRFile
Links a (pseudo-)
anatomical AMR file to an FMR document.
- Document::LinkStimulationProtocol
Links a stimulation
protocol PRT file to an FMR project or a 3D volume time course VTC file.
- Document::LinkVTC
Links a 3D
time course file (VTC) to a 3D anatomical project (VMR).
- Document::LoadGLM
Loads a file
containg the results of a multiple regression (GLM) analysis.
- Document::LoadMesh
Loads a surface
mesh file.
- Document::LoadMultiStudyGLMDefinitionFile
Loads an existing
multi study, multi subject design matrix
- Document::LoadSingleStudyGLMDesignMatrix
Loads an existing
design matrix.
- Document::LoadViewingSettings
Restores surface
module settings about the viewing position, angles, lightning conditions
previously stored to disk.
- Document::MapClusterSize
Valid only
if objDocument is of type FMR or VMR.
-
MapThreshold:
- Document::MapThreshold
Sets the statistical
threshold used in subsequent commands visualizing statistical maps.
- Document::MapThreshold
Gets the statistical
threshold used in subsequent commands visualizing statistical maps.
- Document::MatrixSizeX
Gets number
of columns of slice image matrix
- Document::MatrixSizeY
Gets number
of rows of slice image matrix
- Document::MeshSlicesOff
Removes all
activated slices from the current mesh.
- Document::MorphMesh
Morphs a created
or loaded mesh; typical applications are surface smoothing or skin reconstruction.
- Document::MoveEventRelatedAveragePlot
Moves a previously
created event-related averaging window to a new screen position and changes
its width and height.
- Document::MoveTimeCoursePlot
Moves a previously
created time course window to a new screen position and changes its width
and height.
-
NegativeStatisticalValues:
-
NrOfSkippedVolumes:
-
NrOfSlices:
- Document::NrOfStimulationProtocolConditions
Gets or sets
the number of stimulation protocol conditions
- Document::NrOfVolumes
Gets or sets
number of volumes
-
PathName:
- Document::PixelSizeOfInplaneX
Resolution
of one pixel in x dimension [mm]
- Document::PixelSizeOfInplaneY
Resolution
of one pixel in y dimension [mm]
-
PositiveStatisticalValues:
- Document::PrepareBoundaryReconstruction
This option
guarantees that the subsequent reconstruction process creates a valid
2D surface (eg, without ”moebius bands”).
- Document::ReconstructBoundary
Creates a
new triangle mesh by reconstructing the boundary of a segmented data set.
- Document::RefreshView
Repaints the
document's view which is a window showing an FMR, VMR or AMR project.
- Document::Remove
Method Remove()
is used to remove intermediate fmr-files while preprocessing.
- Document::RemoveBridges
Remove topological
errors named 'handles' or 'bridges' (object produced by puncturing a surface
twice)
- Document::RemoveBridgesEx
Remove topological
errors - extended version
- Document::ReverseSliceOrder
Reverse the
order of the slices (*stc files) from ascending to descending
- Document::RunGLMFromProtocol
Compute the
General Linear Model with the linked protocol
- Document::Save
Saves a BrainVoyager
project file using the current file name
- Document::SaveAs
Saves a BrainVoyager
project file under a specifed file name.
- Document::SaveGLM
Save the computed
General Linear Model with the provided name
- Document::SaveMesh
Saves a surface
mesh file to disk.
- Document::SaveMultiStudyGLMDefinitionFile
Saves a mulit
study, multi subject design matrix
- Document::SaveSingleStudyGLMDesignMatrix
Save the single
study design matrix (reference time course, *rtc)
- Document::SaveSnapshotOfSurfaceWindow
Makes a snapshot
of the surface module window.
- Document::SaveStimulationProtocol
Save the created
protocol.
- Document::SelectAllPredictors
Selects all
predictors of a multiple regression (GLM) result for display.
- Document::SelectPredictorInSet1
Adds a predictor
into set1 of two sets available for display of multiple regression (GLM)
results.
- Document::SelectPredictorInSet2
Adds a predictor
into set2 of two sets available for display of multiple regression (GLM)
results.
- Document::SeparationOfStudyPredictors
GLM-property
- Document::SeparationOfSubjectPredictors
GLM-property
- Document::SetConditionColor
Sets the condition
color in stimulation protocol.
- Document::SetContrastValue
Define whether
a predictor is included in the model Example: 'docSetContrastValue "RVF",
-1'
- Document::SetCrossPosition
Sets the current
voxel.
- Document::SetLayoutRowsCols
Defines a
grid of rows and columns in which multiple images of an FMR or AMR project
are shown.
- Document::SetPredictorValues
Set any predictor
value at any time point (interval) in a design matrix.
- Document::SetPredictorValuesFromCondition
Set predictor
value for a condition in a design matrix.
- Document::SetViewpointPosition
Sets the 3D
position of the viewpoint from which the scene in the Surface Module window
is "seen".
- Document::SetVoxelIntensity
Sets the intensity
value of the specified voxel in an VMR data set.
- Document::SetZoomLevel
Sets the zoom
level of the view of a BrainVoyager project file (FMR, VMR, AMR).
- Document::Show3DVolumeTools
Shows the
3D Volume Tools dialog.
- Document::ShowEventRelatedAverage
Averages events
as specified in an AVG file and shows the event-related averaging results
in a window.
- Document::ShowEventRelatedAverageEx
Averages events
as specified in an AVG file and shows the event-related averaging results
in a window.
- Document::ShowGLM
Shows statistical
map based on selected predictors of a GLM superimposed on (anatomical)
reference images.
- Document::ShowTimeCourseOfVoxel
Shows a time
course from a Region-Of-Interest of the currently linked VTC file.
- Document::ShowTimeCourseOfVoxelEx
Shows a time
course from a Region-Of-Interest of the currently linked VTC file.
- Document::SliceMeshAxial
Slices a surface
mesh parallel to the XY-plane at the specified Z-level.
- Document::SliceMeshCoronal
Slices a surface
mesh parallel to the XZ-plane at the specified Y-level.
- Document::SliceMeshSagittal
Slices a surface
mesh parallel to the YZ-plane at the specified X-level.
-
SliceThickness:
- Document::SliceTimeCorrection
Most EPI sequences
measure the slices of a functional volume in succession but one often
would like to treat the data of one volume as if it were acquired at the
same time, particularly in the context of event-related studies.
- Document::SliceTimeCorrectionEx
Most EPI sequences
measure the slices of a functional volume in succession but one often
would like to treat the data of one volume as if it were acquired at the
same time, particularly in the context of event-related studies.
- Document::SpatialGaussianSmoothing
Spatial Gaussian
smoothing for FMR projects
- Document::SpatialGaussianSmoothingEx
Spatial Gaussian
smoothing for FMR projects - extended version
- Document::SpatialSmoothingFD2D
Spatially
filters each recorded image in the STC files of an FMR project in the
frequency domain.
- Document::SpatialSmoothingFD2DEx
Spatially
filters each recorded image in the STC files of an FMR project in the
frequency domain.
- Document::SpatialSmoothingFD3D
Spatially
filters each 3D volume of a VTC file in the frequency domain.
- Document::SpatialSmoothingFD3DEx
Spatially
filters each 3D volume of a VTC file in the frequency domain.
-
StimulationProtocolBackgroundColorB:
-
StimulationProtocolBackgroundColorG:
-
StimulationProtocolBackgroundColorR:
-
StimulationProtocolExperimentName:
-
StimulationProtocolResolution:
-
StimulationProtocolTextColorB:
-
StimulationProtocolTextColorG:
-
StimulationProtocolTextColorR:
-
StimulationProtocolTimeCourseColorB:
-
StimulationProtocolTimeCourseColorG:
-
StimulationProtocolTimeCourseColorR:
-
StimulationProtocolTimeCourseThickness:
- Document::SwitchToSurfaceModule
Activates
the Surface Module window.
-
TR:
- Document::TemporalGaussianSmoothing
Temporal Gaussian
smoothing
- Document::TemporalGaussianSmoothingEx
Temporal Gaussian
smoothing - extended version
- Document::TemporalHighPassFilter
Apply a HighPassFilter
in the temporal domain; typically used with '2D' fmr files HighPassFiltered
fmr file is saved under name <previous_name>_THP<nr>c.
- Document::TemporalHighPassFilterEx
Apply a HighPassFilter
in the temporal domain; typically used with '2D' fmr files HighPassFiltered
fmr file is saved under name <previous_name>_THP<nr>c.
- Document::TemporalSmoothingFD2D
Filters in
the frequency domain the time series of each voxel in the STC files of
an FMR project.
- Document::TemporalSmoothingFD2DEx
Filters the
time series of each voxel in the STC files of an FMR project.
- Document::TemporalSmoothingFD3D
Filters in
the frequency domain the time series of each voxel in a VTC file.
- Document::TemporalSmoothingFD3DEx
Filters the
time series of each voxel in a VTC file.
-
TimeResolutionVerified:
-
TwoSetContributionMaps:
- Document::UninterleaveSliceOrder
Change the
interleaved slices to continuous ascending or descending
- Document::UpdateSurfaceWindow
Repaints the
Surface Module window which is a window showing one or more surface mesh
files.
- Document::ViewpointRotationX
Rotate the
viewing direction from which the scene in the Surface Module window around
the X-axis (back to front in Talairach space) (in degrees (0-360)).
- Document::ViewpointRotationY
Rotate the
viewing direction from which the scene in the Surface Module window around
the Y-axis (right to left in Talairach space) (in degrees (0-360)).
- Document::ViewpointRotationZ
Rotate the
viewing direction from which the scene in the Surface Module window around
the Z-axis (top to bottom in Talairach space) (in degrees (0-360)).
- Document::ViewpointTranslationX
Move the viewing
direction from which the scene in the Surface Module window is "seen"
right or left.
- Document::ViewpointTranslationY
Move the viewing
direction from which the scene in the Surface Module window is "seen"
up or down.
- Document::ViewpointTranslationZ
Move the viewing
direction from which the scene in the Surface Module window is "seen"
backward or forward.
-
VoxelResolutionVerified:
-
ZTransformationOfStudies:
- importlib
typelib filename:
BrainVoyagerexe