pn2200 / dcm2niix Goto Github PK

dcm2niix is a designed to convert neuroimaging data from the DICOM format to the NIfTI format. This web page hosts the developmental source code - a compiled version for Linux, MacOS, and Windows of the most recent stable release is included with MRIcroGL. A full manual for this software is available in the form of a NITRC wiki.

This software is open source. The bulk of the code is covered by the BSD license. Some units are either public domain (nifti*.*, miniz.c) or use the MIT license (ujpeg.cpp). See the license.txt file for more details.

This software should run on macOS, Linux and Windows typically without requiring any other software. However, if you use dcm2niix to create gz-compressed images it will be faster if you have pigz installed. You can get a version of both dcm2niix and pigz compiled for your operating system by downloading MRIcroGL.

DICOM provides many ways to store/compress image data, known as transfer syntaxes. The COMPILE.md file describes details on how to enable different options to provide support for more formats.

• The base code includes support for raw, run-length encoded, and classic JPEG lossless decoding.
• Lossy JPEG is handled by the included NanoJPEG. This support is modular: you can compile for libjpeg-turbo or disable it altogether.
• JPEG-LS lossless support is optional, and can be provided by using CharLS.
• JPEG2000 lossy and lossless support is optional, and can be provided using OpenJPEG or Jasper.
• GZ compression (e.g. creating .nii.gz images) is optional, and can be provided using either the included miniz or the popular zlib. Of particular note, the Cloudflare zlib exploits modern hardware (available since 2008) for very rapid compression. Alternatively, you can compile dcm2niix without a gzip compressor. Regardless of how you compile dcm2niix, it can use the external program pigz for parallel compression.

See the VERSIONS.md file for details on releases.

Command line usage is described in the NITRC wiki. The minimal command line call would be dcm2niix /path/to/dicom/folder. However, you may want to invoke additional options, for example the call dcm2niix -z y -f %p_%t_%s -o /path/ouput /path/to/dicom/folder will save data as gzip compressed, with the filename based on the protocol name (%p) acquisition time (%t) and DICOM series number (%s), with all files saved to the folder "output". For more help see help: dcm2niix -h.

See the BATCH.md file for instructions on using the batch processing version.

There are a couple ways to install dcm2niix

• Github Releases provides the latest compiled executables. This is an excellent option for MacOS and Windows users. However, the provided Linux executable requires a recent version of Linux, so the provided Unix executable is not suitable for all distributions.
• Assuming the program curl is installed on your computer (e.g. Windows 10 build 1803 or later), you can download the latest Github release with the command. This allows you to download the latest stable release with a single line of code. For Linux (note prior comment regarding older distributions): curl -fLO https://github.com/rordenlab/dcm2niix/releases/latest/download/dcm2niix_lnx.zip. For MacOS: curl -fLO https://github.com/rordenlab/dcm2niix/releases/latest/download/dcm2niix_mac.zip. For Windows: curl -fLO https://github.com/rordenlab/dcm2niix/releases/latest/download/dcm2niix_win.zip.
• MRIcroGL (stable) or MRIcroGL (development) includes dcm2niix that can be run from the command line or from the graphical user interface (select the Import menu item). The Linux version of dcm2niix is compiled on a holy build box, so it should run on any Linux distribution.
• If you have a MacOS computer with Homebrew you can run brew install dcm2niix.
• If you have Conda, conda install -c conda-forge dcm2niix on Linux, MacOS or Windows.
• On Debian Linux computers you can run sudo apt-get install dcm2niix.

It is often easier to download and install a precompiled version. However, you can also build from source.

cmake and pkg-config (optional) can be installed as follows:

Ubuntu: sudo apt-get install cmake pkg-config

MacOS: brew install cmake pkg-config

Basic build:

git clone https://github.com/rordenlab/dcm2niix.git
cd dcm2niix
mkdir build && cd build
cmake ..
make

dcm2niix will be created in the bin subfolder. To install on the system run make install instead of make - this will copy the executable to your path so you do not have to provide the full path to the executable.

In rare case if cmake fails with the message like "Generator: execution of make failed", it could be fixed by sudo ln -s `which make` /usr/bin/gmake.

Advanced build:

As noted in the Image Conversion and Compression Support section, the software provides many optional modules with enhanced features. A common choice might be to include support for JPEG2000, JPEG-LS (this option requires a c++14 compiler), as well as using the high performance Cloudflare zlib library (this option requires a CPU built after 2008). To build with these options simply request them when configuring cmake:

git clone https://github.com/rordenlab/dcm2niix.git
cd dcm2niix
mkdir build && cd build
cmake -DZLIB_IMPLEMENTATION=Cloudflare -DUSE_JPEGLS=ON -DUSE_OPENJPEG=ON ..
make

optional batch processing version:

The batch processing binary dcm2niibatch is optional. To build dcm2niibatch as well change the cmake command to cmake -DBATCH_VERSION=ON ... This requires a compiler that supports c++11.

If you have any problems with the cmake build script described above or want to customize the software see the COMPILE.md file for details on manual compilation.

• dcm2nii is the predecessor of dcm2niix. It is deprecated for modern images, but does handle image formats that predate DICOM (proprietary Elscint, GE and Siemens formats).
• dicm2nii is written in Matlab. The Matlab language makes this very scriptable.
• dicom2nifti uses the scriptable Python wrapper utilizes the high performance GDCMCONV executables.
• dicomtonifti leverages VTK.
• dinifti is focused on conversion of Siemens data.
• DWIConvert converts DICOM images to NRRD and NIfTI formats.
• mcverter has great support for various vendors.
• mri_convert is part of the popular FreeSurfer package. In my limited experience this tool works well for GE and Siemens data, but fails with Philips 4D datasets.
• MRtrix mrconvert is a useful general purpose image converter and handles DTI data well. It is an outstanding tool for modern Philips enhanced images.
• Plastimatch is a Swiss Army knife - it computes registration, image processing, statistics and it has a basic image format converter that can convert some DICOM images to NIfTI or NRRD.
• SPM12 is one of the most popular tools in the field. It includes DICOM to NIfTI conversion. Being based on Matlab it is easy to script.

The following tools exploit dcm2niix

• dcm2niix can help convert data from the Adolescent Brain Cognitive Development (ABCD) DICOM to BIDS
• bidsify is a Python project that uses dcm2niix to convert DICOM and Philips PAR/REC images to the BIDS standard.
• bidskit uses dcm2niix to create BIDS datasets.
• BioImage Suite Web Project is a JavaScript project that uses dcm2niix for its DICOM conversion module.
• boutiques-dcm2niix is a dockerfile for installing and validating dcm2niix.
• DAC2BIDS uses dcm2niibatch to create BIDS datasets.
• Dcm2Bids uses dcm2niix to create BIDS datasets.
• dcm2niir R wrapper for dcm2niix/dcm2nii.
• dcm2niix_afni is a version of dcm2niix included with the AFNI distribution.
• dcm2niiXL is a shell script and tuned compilation of dcm2niix designed for accelerated conversion of extra large datasets.
• dicom2nifti_batch is a Matlab script for automating dcm2niix.
• divest R interface to dcm2niix.
• Functional Real-Time Interactive Endogenous Neuromodulation and Decoding (FRIEND) Engine uses dcm2niix.
• fsleyes is a powerful Python-based image viewer. It uses dcm2niix to handle DICOM files through its fslpy libraries.
• fmrif tools uses dcm2niix for its oxy2bids tool.
• heudiconv can use dcm2niix to create BIDS datasets.
• LEAD-DBS uses dcm2niix for DICOM import.
• MRIcroGL is available for MacOS, Linux and Windows and provides a graphical interface for dcm2niix. You can get compiled copies from the MRIcroGL NITRC web site.
• neuro_docker includes dcm2niix as part of a single, static Dockerfile.
• NeuroDebian provides up-to-date version of dcm2niix for Debian-based systems.
• neurodocker generates custom Dockerfiles given specific versions of neuroimaging software.
• NeuroElf can use dcm2niix to convert DICOM images.
• nipype can use dcm2niix to convert images.
• PNL-nipype is a Python script that can convert dcm2niix created NIfTI files to the popular NRRD format (including DWI gradient tables). Note, recent versions of dcm2niix can directly convert DICOM images to NRRD.
• pydcm2niix is a Python module for working with dcm2niix.
• pyBIDSconv provides a graphical format for converting DICOM images to the BIDS format. It includes clever default heuristics for identifying Siemens scans.
• sci-tran dcm2niix Flywheel Gear (docker).
• The SlicerDcm2nii extension is one method to import DICOM data into Slicer.
• TractoR (Tracto­graphy with R) uses dcm2niix for image conversion.