NRRD NHDR reader and writer
Updated 3 Apr 2019
I have been progressively adding features to existing contributions on the Matlab file exchange and thought the result might be helpful to others.
The new writer module (nhdr_nrrd_write.m) should be compatible with the reader module (nhdr_nrrd_read.m) in that the output of one can be given as an argument to the other to read or produce valid .nhdr/.nrrd files.
Helpful errors and warnings are issued whenever possible.
NRRD FORMAT COMPATIBILITY
A few supported NRRD features:
- detached headers with all variants of 'data file:'
- raw, txt/text/ascii, gz/gzip encodings
- definition of space and orientation
- handling of diffusion-weighted MRI data with '<key>:=<value>' lines such as 'modality:=DWMRI', 'DWMRI_b-value:=' and DWMRI_gradient_0000:=', 'DWMRI_gradient_0001:=', 'DWMRI_gradient_0002:=', etc. (see https://www.na-mic.org/wiki/NAMIC_Wiki:DTI:Nrrd_format)
In general, any field specifier in the header that we were unable to parse is reported in a message printed to the console. Specific examples of unsupported features include:
- reading data along more than 1 dimension or along a dimension other than the slowest (last) axis specified by the optional <subdim>, as
in 'data file: <format> <min> <max> <step> [<subdim>]' or 'data file: LIST [<subdim>]'
- storing all the comments found in headers
- hex, bz2/bzip2 encoding
- byte skip can only accept -1 with raw encoding, 0 for all other encodings
- line skip can only accept 0
- checking that field specifications of the form '<field>: <desc>' appear no more than once in the NRRD header (unlike '<key>:=<value>' lines)
1. The body of the writer module was pretty much written from scratch but the general structure of the reader's main body is based on the Matlab functions maReadNrrdHeader.m and maReadNrrdData.m by email@example.com
and firstname.lastname@example.org .
2. Jeff Mather's nrrd reader
provided the auxiliary functions:
- getDatatype: renamed nrrd_getMatlabDataType. Now throws a gracious error if it encounters 'block'-type data;
- readData: adapted to include a cross-platform fix to delete temporary files when using gzip encoding because David Feng's fix used a Windows-specific command to delete temporary files (https://nl.mathworks.com/matlabcentral/fileexchange/50830-nrrd-format-file-reader).
3. mdcacio's nrrdWriter
provided the auxiliary functions:
- writeData: the 'unexpected end of input stream when attempting to gunzip the file' error was gotten rid of when using gzip encoding. This had actually been similarly fixed by Quan Chen independently;
- setDatatype: renamed get_nrrd_datatype. Reciprocal of getDatatype.
Gaetan Rensonnet (2023). NRRD NHDR reader and writer (https://www.mathworks.com/matlabcentral/fileexchange/66645-nrrd-nhdr-reader-and-writer), MATLAB Central File Exchange. Retrieved .
MATLAB Release Compatibility
Platform CompatibilityWindows macOS Linux
Inspired by: NRRD Format File Reader, NRRD Format File Reader
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!Start Hunting!
Discover Live Editor
Create scripts with code, output, and formatted text in a single executable document.
- more thorough handling of the "space directions" field specifier with detailed warnings and errors and automatic clean up when possible (reader and writer)
- writer function includes a white space between the field name and the field descriptor where that was missing, for the <field>: <desc> lines
- fixed error in handling of 'space directions' specification