.\" Man page generated from reStructuredText.
.
.TH "DCM2NIIX" "1" "Nov 13, 2020" "1.0" "dcm2niix"
.SH NAME
dcm2niix \- DICOM to NifTI converter
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBdcm2niix\fP [\fIoptions\fP] <\fIsourcedir\fP>
.SH DESCRIPTION
.sp
Most medical imaging devices save images in some variation of the popular DICOM
format. However, most scientific tools expect medical images to be stored in
the comparatively simpler NIfTI format. \fBdcm2niix\fP is designed to perform
such conversion from DICOM to NIfTI with a simple command\-line interface.
.sp
Please be advised that \fBdcm2niix\fP has been developed for research purposes
only and should not be considered a clinical tool.
.SH OPTIONS
.sp
\-1..\-9          gz compression level (1=fastest..9=smallest, default 6)
.INDENT 0.0
.TP
.BI \-b \ <y/i/n>
Save additional BIDS metadata to a side\-car .json file.
The "i"nput\-only option reads DICOMs but saves neither BIDS nor NIfTI.
.UNINDENT
.sp
\-ba <y/n>       anonymize BIDS
.INDENT 0.0
.TP
.BI \-f \ <format>
Format string for the output filename(s). The following
specifiers are supported:
.INDENT 7.0
.IP \(bu 2
%a, antenna (coil) name
.IP \(bu 2
%b, basename (filename of 1st DICOM file)
.IP \(bu 2
%c, comments
.IP \(bu 2
%d, description
.IP \(bu 2
%e, echo number
.IP \(bu 2
%f, folder name
.IP \(bu 2
%i, patient ID
.IP \(bu 2
%j, seriesInstanceUID
.IP \(bu 2
%k, studyInstanceUID
.IP \(bu 2
%m, manufacturer
.IP \(bu 2
%n, patient name
.IP \(bu 2
%p, protocol
.IP \(bu 2
%r, instance number (of 1st DICOM file)
.IP \(bu 2
%s, series number
.IP \(bu 2
%t, time
.IP \(bu 2
%u, acquisition number
.IP \(bu 2
%v, vendor
.IP \(bu 2
%x, study ID
.IP \(bu 2
%z, sequence name
.UNINDENT
.sp
The default format string is "%p_%e_%4s".
.TP
.BI \-i \ <y/n>
Ignore derived, localizer and 2D images.
.TP
.BI \-l \ <y/n>
Losslessly scale 16\-bit integers to use maximal dynamic range.
.TP
.BI \-m \ <y/n>
Merge slices from the same series regardless of study time,
echo, coil, orientation, etc...
.TP
.BI \-n \ <number>
Only convert this series number. Provide a negative number for
listing of series numbers in input folder.
.TP
.BI \-o \ <path>
Output directory where the converted files should be saved. If
unspecified, the files are saved within the specified source
directory.
.TP
.BI \-p \ <y/n>
Use Philips precise float (rather than display) scaling.
.TP
.BI \-r \ <y/n>
Rename instead of convert DICOMs. Useful for organizing images.
.TP
.BI \-s \ <y/n>
Convert a single file only.
.TP
.BI \-t \ <y/n>
Save patient details as text notes.
.TP
.B \-u
Update check: attempts to see if newer version is available.
.TP
.BI \-v \ <h/y/n>
Enable verbose output. "n" for succinct, "y" for verbose, "h" for
high verbosity
.TP
.BI \-x \ <y/n>
Crop images. This will attempt to remove excess neck from 3D acquisitions.
.TP
.BI \-z \ <y/i/n>
Desired compression method. The "y"es option uses the external
program pigz if available. The "i" option compresses the image
using the slower built\-in compression routines.
.UNINDENT
.SH LICENSING
.sp
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and this
notice are preserved. This file is offered as\-is, without any warranty.
The dcm2niix project is distributed under the BSD 2\-Clause License.
.SH AUTHOR
This manual was developed by Ghislain Antony Vaillant and is maintained by the community
.SH COPYRIGHT
2020 The dcm2niix contributors
.\" Generated by docutils manpage writer.
.