tessl install tessl/pypi-dcm2niix@1.0.5Command-line application that converts medical imaging data from DICOM format to NIfTI format with BIDS support
dcm2niix supports multiple output formats and provides extensive file naming customization through postfixes and patterns.
Export converted medical images to various formats.
-e n # NIfTI format (default)NIfTI (Neuroimaging Informatics Technology Initiative)
.nii (uncompressed) or .nii.gz (gzip compressed)-e y # NRRD formatNRRD (Nearly Raw Raster Data)
.nrrd-e o # MGH/MGZ formatMGH/MGZ (Massachusetts General Hospital format)
.mgh (uncompressed) or .mgz (gzip compressed)-e j # JNIfTI format (requires compile support)JNIfTI (JSON NIfTI)
.jnii-e b # BJNIfTI format (requires compile support)BJNIfTI (Binary JSON NIfTI)
.bniiControl output file compression.
-z y # Use pigz (parallel gzip)
-z i # Internal compression (miniz/zlib)
-z n # No compression
-z 3 # No compression, force 3D output
-z o # Optimal pigz (Unix only)Pigz Compression (-z y)
Internal Compression (-z i)
Compression Levels (-1 to -9)
-1: Fastest compression, larger files-6: Default balance (MZ_DEFAULT_LEVEL)-9: Smallest files, slower compressionCustomize output filenames using template placeholders.
-f <pattern>Available Placeholders:
Patient identifiers (anonymized when -ba y):
%i = Patient ID (0010,0020)%n = Patient name (0010,0010)%w = Weird/personal data (DOB, gender, weight, institution - contains PHI)Study identifiers:
%g = Accession number (0008,0050)%x = Study ID (0020,0010)%k = Study instance UID (0020,000D)%t = Study time (formatted from 0008,0020 and 0008,0030)%l = Local procedure step description (0040,0254)Series identifiers:
%s = Series number (0020,0011)%j = Series instance UID (0020,000E)%d = Series description (0008,103E)%p = Protocol name (0018,1030)%z = Sequence name (0018,0024)%q = Sequence number (if compiled with mySegmentByAcq)Instance identifiers:
%r = Instance number (0020,0013)%u = Acquisition number (0020,0012)%e = Echo number (0018,0086)%y = Youth in series (GE RawDataRunNumber or TemporalPosition)Hardware identifiers:
%m = Manufacturer (short: GE, Ph, Si, To, UI, NA)%v = Vendor (long: Siemens, Philips, GE, etc.)%a = Antenna/coil name (Siemens-specific, 0051,100F)File/folder identifiers:
%f = Folder name (directory containing first DICOM)%b = Basename (filename of first DICOM file)Other:
%c = Comments (DICOM tag 0020,4000)%h = Hazardous/experimental BIDS naming (ReproIn format, use with caution)%o = Media object instance UID (0002,0003)Default pattern: %f_%p_%t_%s
dcm2niix automatically appends postfixes to disambiguate multi-volume outputs (unless --terse is used).
_e<N> # Echo number (multi-echo sequences)
_c<N> # Coil element (uncombined data)
_i<N> # Image number (non-parallel slices)
_r<N> # Repetition (multiple repetition times)
_t # Trigger delay time (cardiac gating)Examples:
T2_FLAIR_5_e1.nii - First echo of multi-echo T2 FLAIRT1_MPRAGE_3_e1.nii, T1_MPRAGE_3_e2.nii - Two echoesEPI_bold_10_c1.nii through EPI_bold_10_c32.nii - 32-element coil array_real # Real component of complex image
_imaginary # Imaginary component of complex image
_ph # Phase map
_phMag # Phase and magnitude combined as 4th dimension
_ADC # Philips derived ADC volume
_fieldmaphz # Philips B0 field map in HzExamples:
GRE_5_real.nii, GRE_5_imaginary.nii - Complex gradient echoB0map_7_fieldmaphz.nii - Field map in HertzDWI_12_ADC.nii - Apparent diffusion coefficient map_MoCo # Motion corrected variant
_Eq # Equidistant spacing (resliced)
_Tilt # CT gantry tilt correction appliedExamples:
EPI_8_MoCo.nii - Motion-corrected EPICT_spine_2_Tilt.nii - Gantry tilt corrected_Raw # Philips Raw Data Storage (XX_*)
_PS # Philips Presentation State (PS_*)_ROI<N> # DICOM binary overlay (N = 1-16)Examples:
T1_3_ROI1.nii - First region of interest overlayT2_5_ROI2.nii - Second overlayControl behavior when output files already exist.
-w 0 # Skip duplicates (don't overwrite)
-w 1 # Overwrite existing files
-w 2 # Add suffix (default)Skip Mode (-w 0):
Overwrite Mode (-w 1):
Add Suffix Mode (-w 2, default):
_i, _j, _k, etc. to create unique filenameT1.nii already exists → creates T1_i.niiDisable automatic postfix generation.
--terseWhen enabled:
_e, _c, _i, _r dimensional postfixesdcm2niix -z y -o /output /inputCreates compressed NIfTI files (.nii.gz) using pigz.
dcm2niix -e y -o /output/nrrd /input/dicomExports to NRRD format for use in scientific visualization tools.
dcm2niix -e o -z y /freesurfer/inputCreates compressed MGH files (.mgz) for FreeSurfer processing.
dcm2niix -f sub-%i_ses-01_run-%s_%d /inputExample output: sub-12345_ses-01_run-5_T1_MPRAGE.nii
dcm2niix -f %p_%s -o /output /inputSimple naming: T1_MPRAGE_5.nii, T2_FLAIR_8.nii
dcm2niix --terse -f %p /single/echo/inputMinimal naming without postfixes: T1_MPRAGE.nii
dcm2niix -9 -z y -o /output /inputHighest compression level (9) with pigz parallelization.
dcm2niix -w 1 -o /output /inputReplaces existing NIfTI files without creating duplicates.
dcm2niix -w 0 -o /output /inputOnly converts DICOM series that don't already have NIfTI outputs.
| Format | Uncompressed | Compressed |
|---|---|---|
| NIfTI | .nii | .nii.gz |
| MGH | .mgh | .mgz |
| NRRD | .nrrd | .nrrd |
| JNIfTI | .jnii | .jnii |
| BJNIfTI | .bnii | .bnii |
brew install pigz (macOS) or apt-get install pigz (Ubuntu).json) are created alongside primary output files when -b y