v2.0.0
Loading...
Searching...
No Matches
mri_types.h File Reference

MRI type definitions and constants. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  MRILIB
 MRI volume and coordinate-system I/O (volumes, voxel geometry, transforms).

Variables

MGH Format Version
constexpr int MRILIB::MRI_MGH_VERSION = 1
MGH Voxel Data Types

Data type codes for voxels in MGH/MGZ files. From FreeSurfer mri.h and MNE C mne_types_mne-c.h.

See: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat "type: data type of the image buffer; can be one of the following: UCHAR, SHORT, INT, or FLOAT (specified as 0, 4, 1, or 3, respectively)"

constexpr int MRILIB::MRI_UCHAR = 0
constexpr int MRILIB::MRI_INT = 1
constexpr int MRILIB::MRI_LONG = 2
constexpr int MRILIB::MRI_FLOAT = 3
constexpr int MRILIB::MRI_SHORT = 4
constexpr int MRILIB::MRI_BITMAP = 5
constexpr int MRILIB::MRI_TENSOR = 6
Frame Loading Constants
constexpr int MRILIB::MRI_ALL_FRAMES = -1
constexpr int MRILIB::MRI_NO_FRAMES = -2
MGH Header Constants

Fixed offsets and sizes in the MGH file header. See: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat

constexpr int MRILIB::MRI_MGH_DATA_OFFSET = 284
constexpr int MRILIB::MRI_MGH_HEADER_FIXED_SIZE = 30
MGH Footer Tag Types

Tag identifiers found in the MGH footer after the voxel data. From FreeSurfer tags.h.

constexpr int MRILIB::MGH_TAG_OLD_SURF_GEOM = 20
constexpr int MRILIB::MGH_TAG_OLD_MGH_XFORM = 30
constexpr int MRILIB::MGH_TAG_MGH_XFORM = 31
COR Slice Constants

Fixed dimensions for FreeSurfer COR slice files. COR files contain 256 coronal slices of 256×256 unsigned chars at 1mm isotropic.

constexpr int MRILIB::COR_NSLICE = 256
constexpr int MRILIB::COR_WIDTH = 256
constexpr int MRILIB::COR_HEIGHT = 256
constexpr float MRILIB::COR_PIXEL_SIZE = 1e-3f

Detailed Description

MRI type definitions and constants.

Author
Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org
Since
2.0.0
Date
February, 2026

LICENSE

Copyright (C) 2026, Christoph Dinh. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of MNE-CPP authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

      Constants and type definitions for handling FreeSurfer MRI data
      in MGH/MGZ format. Based on the FreeSurfer MGH format specification:
      https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat

      Originally defined in MNE C (mne_types_mne-c.h) by Matti Hamalainen.

Definition in file mri_types.h.