BrainVoyager Python Developer Guide 0.9

Mesh Properties

The following properties are exposed by the Mesh object. Besides the properties described below, a Mesh object also provides commands that can be used to modify meshes (e.g. shape, colors) and to link time course (.mtc) and surface map (.smp) data .

mesh_scene → MeshScenePyBV

Description: This read-only property retrieves the mesh scene (MeshScenePyBV) object that contains the calling MeshPyBV object. This property is useful if one wants to access other meshes in the same mesh scene. Note that a MeshScenePyBV object can also be accessed using the 'mesh_scene' property of VMR documents.

file_name → str

Description: This read-write property retrieves or sets the file name of the MeshPyBV object. It is recommended to include the full file path in the file name.

n_vertices → int

Description: This read-only property retrieves the number of vertices of the MeshPyBV object.

n_maps → int

Description: This read-only property retrieves the number of sub-maps of surface map data linked to the calling mesh object. This value can be used, for example, to iterate through all sub-maps of a created or loaded surface map (SMP).

n_mtc_time_points → int

Description: This read-only property retrieves the number of time points of a linked MTC file. In case that no MTC file is linked to the MeshPyBV object, value '0' is returned.

correct_serial_correlations → int

Description: This property can be used to read and change the setting used for correcting serial correlations when subsequently running GLM statistical analyses using one or more mesh time course MTC files. A value of '0' will turn off correction of serial correlations. Values '1' and '2' will enable correction of serial correlations using an AR(1) or AR(2) model, respectively.

file_name_preprocessd_mtc → str

Description: This property retrieves the name of a linked MTC file with a suffix representing performed preprocessing steps (e.g. smoothing, filtering). This can be used as a suggested new name, e.g. when saving the preprocessed mesh time course to disk.

morphing_update_interval → int

Description: This property retrieves and sets the number of morphing steps after which the mesh object will be updated during a subsequent iterative morphing process (e.g. inflation, flattening, morph-to-sphere). Note that for efficiency, the visual representation of a mesh is not updated at each step during a lenghty morphing process (except if one sets this property to '1').