write.fs.volume: Write an fs.volume instance to a file in MGH, MGZ or NIFTI v1...

In freesurferformats: Read and Write 'FreeSurfer' Neuroimaging File Formats

Write an fs.volume instance to a file in MGH, MGZ or NIFTI v1 format.

Description

Write brain volume data to a file. The format is determined from the file extension of 'filepath'.

Usage

write.fs.volume(filepath, fs_vol)

Arguments

filepath	string. Full path to the output file. The file extension determines the format: '.mgh' or '.mgz' for FreeSurfer MGH/MGZ format, '.nii' or '.nii.gz' for NIFTI v1 format.
fs_vol	an 'fs.volume' instance, as returned by read.fs.volume with parameter 'with_header=TRUE'.

Note

When writing NIFTI files, this function uses nii1header.for.mgh to compute a NIFTI v1 header from the MGH header information.

Examples

## Not run: 
    mgh_file = system.file("extdata", "brain.mgz",
                            package = "freesurferformats",
                            mustWork = TRUE);
    fs_vol = read.fs.volume(mgh_file, with_header = TRUE);
    write.fs.volume(tempfile(fileext=".mgz"), fs_vol);
    write.fs.volume(tempfile(fileext=".nii.gz"), fs_vol);

## End(Not run)

freesurferformats documentation built on July 8, 2026, 5:08 p.m.