Brain Innovation

support portal

An anatomical-resolution VMP (volume map) file contains statistical results in 3D format. Results of statistical tests computed with a VMR-VTC project are stored in a native-resolution VMP data structure. For visualization, the NR-VMP is interpolated to the resolution of the hosting anatomical (VMR) data set. Note, that NR-VMPs are the default format in BrainVoyager QX and should be used for storing custom data, if possible. You may save/load a AR-VMP file using the GUI or scripting commands. A single VMP file may contain an array of individual 3D data sets. VMP maps are stored in the resolution of VMR files (typically 1x1x1 mm voxels) whereas NR-VMPs are stored in the resolution of VTC files (typically 3x3x3 mm voxels).

The binary AR-VMP file contains a variable-length header followed by the data containing (statistical) values in 4 byte float format. To reduce the size of the data both on disk and in memory, only the subvolume containing data is stored. The subvolume is specified with three pairs of start/end values. The current version of AR-VMP files is 5. Older versions are also described below.

AR-VMP Header (Version 5)

BYTES DATA TYPE DEFAULT DESCRIPTION
2 short int 5 VersionNumber
4 int 1 NrOfMaps (number of 3D maps)
 
4 int 1 TypeOfMap of sub-map "m" (all sub-maps should have same type at present)
4 int   NrOfLags - only stored if "TypeOf Map" = 3
4 int   DisplayMinLag - only stored if "TypeOf Map" = 3
4 int   DisplayMaxLag - only stored if "TypeOf Map" = 3
4 int   ShowCorrelationOrLag - only stored if "TypeOf Map" = 3
4 int   ClusterSizeThreshold for sub-map "m"
1 byte   EnableClusterSizeThreshold for sub-map "m"
4 float   Threshold for sub-map "m"
4 float   UpperThreshold (only used to determine color range)
4 int 1 ShowValuesAboveUpperThreshold
4 int 0 DF1 (degrees-of-freedom)
4 int 0 DF2 (degrees-of-freedom)
4 int 3 ShowPosNegValues flag (1 -> pos, 2 -> neg, 3 -> both)
4 int 0 NrOfUsedVoxels (e.g. no. masked voxels for p correction methods)
3 byte   R, G and B part of color for positive values above threshold (positive min value)
3 byte   R, G and B part of color for values at and above upper threshold (positive max value)
3 byte   R, G and B part of color for negative values above threshold (negative min value)
3 byte   R, G and B part of color for values at and above upper threshold (negative max value)
1 byte 0 UseVMPColor - Use map-specific color ("1") or generic look-up table ("0")
N_Name byte   LUTFileName - Name of color look-up table to be used for this sub-map
4 float 1.0 TransparentColorFactor - Blend map colors with anatomical background
N_Name byte 0 MapName - Name of sub-map "m"
 
4 int 256 DimX of VMR from which VMP was saved
4 int 256 DimY of VMR from which VMP was saved
4 int 256 DimZ of VMR from which VMP was saved
4 int 57 XStart (subvolume specification)
4 int 231 XEnd (subvolume specification)
4 int 52 YStart (subvolume specification)
4 int 172 YEnd (subvolume specification)
4 int 59 ZStart (subvolume specification)
4 int 197 ZEnd (subvolume specification)
4 int 1 Resolution (should be "1" at present)

 

AR-VMP Header (Version 3)

BYTES DATA TYPE DEFAULT DESCRIPTION
2 short int 3 VersionNumber
4 int 1 NrOfMaps (number of 3D maps)
 
4 int 1 TypeOfMap of sub-map "m" (all sub-maps should have same type at present)
4 int   NrOfLags - only stored if "TypeOf Map" = 3
4 int   DisplayMinLag - only stored if "TypeOf Map" = 3
4 int   DisplayMaxLag - only stored if "TypeOf Map" = 3
4 int   ShowCorrelationOrLag - only stored if "TypeOf Map" = 3
4 int   ClusterSizeThreshold for sub-map "m"
1 byte   EnableClusterSizeThreshold for sub-map "m"
4 float   Threshold for sub-map "m"
4 float   UpperThreshold ( only used to determine color range)
4 int 1 ShowValuesAboveUpperThreshold
4 int 0 DF1 (degrees-of-freedom)
4 int 0 DF2 (degrees-of-freedom)
4 int 0 NrOfMaskVoxels (for p correction methods)
3 byte   R, G and B part of color for positive values above threshold (positive min value)
3 byte   R, G and B part of color for values at and above upper threshold (positive max value)
3 byte   R, G and B part of color for negative values above threshold (negative min value)
3 byte   R, G and B part of color for values at and above upper threshold (negative max value)
1 byte 0 UseVMPColor - Use map-specific color ("1") or generic look-up table ("0")
4 float 1.0 TransparentColorFactor - Blend map colors with anatomical background
N_Name byte 0 MapName - Name of sub-map "m"
 
4 int 256 DimX of VMR from which VMP was saved
4 int 256 DimY of VMR from which VMP was saved
4 int 256 DimZ of VMR from which VMP was saved
4 int 57 XStart (subvolume specification)
4 int 231 XEnd (subvolume specification)
4 int 52 YStart (subvolume specification)
4 int 172 YEnd (subvolume specification)
4 int 59 ZStart (subvolume specification)
4 int 197 ZEnd (subvolume specification)
4 int 1 Resolution (should be "1" at present)


Notes

An AR-VMP file may contain any type of value, e.g. from both hypothesis- and data-driven analyses. For proper default settings for visualizaing VMP data structures, some values for "TypeOfMap" are reserved, i.e., 1 -> t-values, 2 -> correlation values, 3 -> cross-correlation values, 4 -> F-values, 11 -> percent signal change values, 12 -> ICA z values.

BrainVoyager map type codes:
1: T-statistic

2: correlation

3: cross-correlation

4: F-statistic

5: Z-statistic

11: percent signal change

12: ICA

14: chi^2

15: beta

16: probability
21: mean diffusivity map
22: fractional anisotropy map

The "X/Y/Z Start/End" values indicate the relative position of the VMP subvolume within a 2563 VMR volume (see explanations below).

The "Resolution" value is defined with respect to the resolution of a VMR file. Typically, one VMR voxel has the resolution of 1 (Talairach) mm3. AR-VMP files normally also have a resolution of 1. Other resolutions are not supported at present. If a statistic has been computed from a VTC with a lower resolution (i.e. 3), the resulting map is kept as a native-resolution VMP, which is for display interpolated to the standard VMR resolution automatically creating a anatomical-resolution VMP.


AR-VMP Data

A VMP file contains DimN = NrOfMaps 3D data sets. Each data set contains a 3D representation of a (statistical) entity. Each data element (single value) is represented in float format (4 bytes per value). The data is organized in four loops:

DimN (NrOfMaps)

DimZ

DimY

DimX

The spatial dimensions can be computed from the header info as follows (Resolution should be "1" at present):

DimX = (XEnd - XStart + 1) / Resolution
DimY = (YEnd - YStart + 1) / Resolution
DimZ = (ZEnd - ZStart + 1) / Resolution

Note that the axes terminology follows the internal BrainVoyager format. The mapping to Talairach axes is as follows:

BV X front -> back = Y in Tal space
BV Y top -> bottom = Z in Tal space
BV Z left -> right = X in Tal space

You are here: HomeBrainVoyagerAutomation & DevelopmentFile Formats ≫ Users Guide (2.3) - The Format Of AR-VMP Files