tessl install tessl/pypi-dcm2niix@1.0.5Command-line application that converts medical imaging data from DICOM format to NIfTI format with BIDS support
Control which DICOM images are converted by filtering and selecting specific series or image types.
Filter out secondary captures, scout images, and 2D slices.
-i <y/n>Ignore derived, localizer, and 2D images:
y = skip derived images, localizers, and 2D acquisitionsn = include all images (default)What Gets Filtered:
When to Use:
Example:
dcm2niix -i y /mixed/dicom/folderConvert only specific series identified by CRC checksum.
-n <CRC_number>Only convert series matching specified CRC. Can be used up to 16 times for multiple series.
How It Works:
-q l to list all series with their CRC values-n to convert only those seriesUse Cases:
Example:
# First, list series to find CRC values
dcm2niix -q l /dicom/folder
# Then convert only desired series
dcm2niix -n 52301 -n 52305 -n 52310 /dicom/folderConvert a single DICOM file without searching the folder.
-s <y/n>Single file mode:
y = only convert the specified DICOM filen = search folder for related files (default)When to Use:
Example:
dcm2niix -s y /path/to/single_image.dcmNote: Output may be incomplete if the file is part of a multi-slice volume.
Control whether 2D slices from the same series are merged into volumes.
-m <n/y/0/1/2>Merge 2D slices mode:
n or 0 = don't merge, create separate file for each slicey or 1 = merge all 2D slices from same series into volume2 = auto mode (default, intelligent merging)Auto Mode Behavior:
Use Cases:
n: Keep 2D slices separate for manual inspectiony: Force merging even with parameter variations (may create incorrect volumes)2: Recommended for most use cases, smart mergingExample:
# Don't merge, one file per slice
dcm2niix -m n /2d/slices/folder
# Force merge all slices
dcm2niix -m y /2d/slices/folder
# Auto mode (default)
dcm2niix -m 2 /2d/slices/folderControl how deep to search for DICOM files in subdirectories.
-d <0-9>Search depth (0-9 levels):
0 = only search specified folder, no subdirectories1 = search one level deep5 = search five levels deep (default)9 = search nine levels deepWhen to Adjust:
Example:
# Only search specified folder
dcm2niix -d 0 /flat/dicom/folder
# Search deeply nested structure
dcm2niix -d 9 /deeply/nested/dicomsOptimize for datasets where series are pre-organized into folders.
-a <y/n>Adjacent DICOMs:
y = assume all images from same series are in same folder (faster)n = search all folders for series members (default, safer)When to Use:
y: Pre-organized datasets (e.g., PACS exports where each series has its own folder)n: Mixed datasets where series may span multiple foldersPerformance:
Example:
# Fast mode for organized data
dcm2niix -a y /organized/pacs/export
# Safe mode for mixed data
dcm2niix -a n /mixed/dicomsControl console output during DICOM file discovery.
-q <y/l/n>Directory search reporting:
y = show number of DICOM files found (default)l = list all DICOM files found with details (including CRC)n = no search reporting (quiet)Use Cases:
y: Standard feedback during conversionl: Identify series CRC values for selective conversion with -nn: Minimal output for batch processing scriptsExample:
# List all series with CRC values
dcm2niix -q l /dicom/folderOutput Format (with -q l):
Found 240 DICOM files in /dicom/folder
Series 001: T1_MPRAGE [52301] - 176 files
Series 002: T2_FLAIR [52305] - 32 files
Series 003: BOLD_fMRI [52310] - 240 filesAllow merging of series with different SeriesInstanceUIDs.
# Controlled by isIgnoreSeriesInstanceUID setting (default: false)
# Typically set via configuration fileWhat This Does:
Risk:
dcm2niix -i y -d 5 /mixed/dicom/exportConverts only primary acquisitions, skipping scouts, localizers, and derived images.
# Step 1: Identify series
dcm2niix -q l /dicom/folder
# Step 2: Convert only T1 MPRAGE and BOLD
dcm2niix -n 52301 -n 52310 /dicom/folderdcm2niix -a y -d 1 -q y /organized/pacs/exportAssumes adjacent organization, shallow search, with progress feedback.
dcm2niix -n 52305 -i y /large/exam/folderConverts only series 52305, ignoring derived/localizer images.
dcm2niix -m 2 -i n /mixed/2d/slicesAuto mode for slice merging, includes all image types.
dcm2niix -m n /2d/localizersCreates one NIfTI file per DICOM slice, useful for quality control.
dcm2niix -d 1 -q n /flat/dicom/folderSearches only one level deep, minimal console output.
Question 1: Do you want to include derived/localizer images?
-i y-i n (default)Question 2: Do you know which series to convert?
-q l to find CRC, then -n <CRC> for each seriesQuestion 3: Are series organized into separate folders?
-a y for faster conversion-a n (default)Question 4: How should 2D slices be handled?
-m 2 (auto, default)-m y-m nQuestion 5: How deep is your directory structure?
-d 0 or -d 1-d 5 (default) or higher