1DCM2NIIX(1)                        dcm2niix                        DCM2NIIX(1)
2
3
4

NAME

6       dcm2niix - DICOM to NifTI converter
7

SYNOPSIS

9       dcm2niix [options] <sourcedir>
10

DESCRIPTION

12       Most medical imaging devices save images in some variation of the popu‐
13       lar DICOM format. However, most scientific tools expect medical  images
14       to be stored in the comparatively simpler NIfTI format. dcm2niix is de‐
15       signed to perform such conversion from DICOM to  NIfTI  with  a  simple
16       command-line interface.
17
18       Please  be  advised  that dcm2niix has been developed for research pur‐
19       poses only and should not be considered a clinical tool.
20

OPTIONS

22       -1..-9          gz compression level (1=fastest..9=smallest, default 6)
23
24       -b <y/i/n>
25              Save additional BIDS metadata to a side-car .json file  (default
26              y).  The "i"nput-only option reads DICOMs but saves neither BIDS
27              nor NIfTI.
28
29       -ba <y/n> anonymize BIDS (default y).
30              If "n"o, side-car may report patient name, age and weight.
31
32       -f <format>
33              Format string for the output filename(s). The  following  speci‐
34              fiers are supported:
35
36              • %a, antenna (coil) name
37
38              • %b, basename (filename of 1st DICOM file)
39
40              • %c, comments
41
42              • %d, description
43
44              • %e, echo number
45
46              • %f, folder name
47
48              • %i, patient ID
49
50              • %j, series instance UID
51
52              • %k, study instance UID
53
54              • %m, manufacturer
55
56              • %n, patient name
57
58              • %o, media object instance UID
59
60              • %p, protocol
61
62              • %r, instance number (of 1st DICOM file)
63
64              • %s, series number
65
66              • %t, time
67
68              • %u, acquisition number
69
70              • %v, vendor
71
72              • %x, study ID
73
74              • %z, sequence name
75
76              The default format string is "%p_%e_%4s".
77
78       -g <y/n/o/i>
79              Generate  defaults  file (default n) If "y", create default file
80              on completion If "n", default will not be written If  "o",  only
81              reset and write defaults If "i", the values of the defaults file
82              are ignored : reset defaults], default n)
83
84       -h     Show help
85
86       -i <y/n>
87              Ignore derived, localizer and 2D images (default n)
88
89       -l <y/n/o>
90              Losslessly scale 16-bit integers to use  maximal  dynamic  range
91              (default o).  If "y", then intensity rescaled to use full 16-bit
92              range.  If "n", data not scaled uint16 will be saved  as  int16.
93              If "o", original data and datatype preserved.
94
95       -m <y/n/2>
96              Merge  slices  from  the  same  series regardless of study time,
97              echo, coil, orientation, etc. (default 2).   If  "2",  automatic
98              based on image modality.
99
100       -n <number>
101              Only  convert  this series CRC number. Provide a negative number
102              for listing of series CRC numbers in input folder.
103
104       -o <path>
105              Output directory where the converted files should be  saved.  If
106              unspecified, the files are saved within the specified source di‐
107              rectory.
108
109       -p <y/n>
110              Use Philips precise float (rather than display) scaling.
111
112       -r <y/n>
113              Rename instead of convert DICOMs. Useful for organizing images.
114
115       -s <y/n>
116              Convert a single file only.
117
118       -t <y/n>
119              Save patient details as text notes.
120
121       -u     Update check: attempts to see if newer version is available.
122
123       -v <2/y/n>
124              Enable verbose output. "n" for succinct, "y"  for  verbose,  "2"
125              for high verbosity
126
127       -x <y/n/i>
128              Crop images. This will attempt to remove excess neck from 3D ac‐
129              quisitions.  If "i", images are neither cropped nor  rotated  to
130              canonical space.
131
132       -z <y/i/n>
133              Desired  compression  method. The "y"es option uses the external
134              program pigz if available. The "i" option compresses  the  image
135              using the slower built-in compression routines.
136
137       --big-endian <y/n/o>
138              Byte order (default o). Optimal is machine native
139
140       --progress
141              Slicer format progress information (y/n, default n)
142
143       --ignore_trigger_times
144              Disregard values in 0018,1060 and 0020,9153
145
146       --terse
147              Omit filename post-fixes (can cause overwrites)
148
149       --version
150              Report version and terminate
151
152       --xml  Slicer format features
153

LICENSING

155       Copying  and  distribution  of this file, with or without modification,
156       are permitted in any medium without royalty provided the copyright  no‐
157       tice and this notice are preserved. This file is offered as-is, without
158       any warranty.  The  dcm2niix  project  is  distributed  under  the  BSD
159       2-Clause License.
160

AUTHOR

162       This manual was developed by Ghislain Antony Vaillant and is maintained
163       by the community
164

COPYRIGHT

166       2023 The dcm2niix contributors
167
168
169
170
1711.0                              Jan 19, 2023                      DCM2NIIX(1)