Skip to content

Commit dda0e88

Browse files
committed
Merge branch 'dicom2niix' of https://github.com/jph6366/TF2.4_IVIM-MRI_CodeCollection into dicom2niix
2 parents 614c8f8 + 9a17fb1 commit dda0e88

File tree

1 file changed

+11
-23
lines changed

1 file changed

+11
-23
lines changed

Docker/README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,17 @@ Before running the Docker container, here are the available options for the `Doc
8181

8282
- You can run the dicom2niix_wrapper.py script either directly or from inside a Docker container (non-interactive only). Here are the available options:
8383

84+
## Options
85+
Before running the Docker container, here are the available options for the `Docker image` script:
86+
87+
- `input`: Path to the input DICOM directory. Some scanners store images in nested subfolders, so a single session might be stored in the folders "/usr/subj22/111", "/usr/subj22/112" and "/usr/subj22/123". In this case you should simply provide the parent directly ("/usr/subj22") and dcm2niix will recursively search the sub directories and organize all your images for you.
88+
- `output`: Path to the output directory for the converted NIfTI files and sidecar BIDS JSON.
89+
- ` -m, --merge-2d`: Merge 2D slices into a 3D or 4D NIfTI image regardless of study time, echo, coil, orientation, etc. Depending on your vendor, you may want to keep images segmented based on these attributes or merge/combine them.
90+
- ` -s, --single-file`: Use single file mode (convert only one series per folder). For example, if the input path "~/dir/001.dcm" will only convert the file 001.dcm.
91+
- ` -pu, --prompt-user`: Run the tool in interactive mode. This launches a terminal-based wizard where you can select DICOM folders and configure conversion interactively.
92+
93+
94+
8495
### Example usage
8596

8697
```sh
@@ -107,29 +118,6 @@ sudo docker run -it --rm --name TF2.4_IVIM-MRI_CodeCollection \
107118
/usr/src/app/dicom_file -o /usr/app/output -s
108119
```
109120

110-
#### Required parameters
111-
112-
input: Path to the input DICOM directory. Some scanners store images in nested subfolders, so a single session might be stored in the folders "/usr/subj22/111", "/usr/subj22/112" and "/usr/subj22/123". In this case you should simply provide the parent directly ("/usr/subj22") and dcm2niix will recursively search the sub directories and organize all your images for you.
113-
114-
output: Path to the output directory for the converted NIfTI files.
115-
116-
#### Optional Flags
117-
118-
#### -m, --merge-2d
119-
120-
Merge 2D slices into a 3D or 4D NIfTI image regardless of study time, echo, coil, orientation, etc.
121-
Depending on your vendor, you may want to keep images segmented based on these attributes or merge/combine them.
122-
123-
#### -s, --single-file
124-
125-
Use single file mode (convert only one series per folder).
126-
127-
For example, if the input path "~/dir/001.dcm" will only convert the file 001.dcm.
128-
129-
#### -pu, --prompt-user
130-
131-
Run the tool in interactive mode. This launches a terminal-based wizard where you can select DICOM folders and configure conversion interactively.
132-
133121
[Note that NIfTI and DICOM encode space differently](https://www.nitrc.org/plugins/mwiki/index.php/dcm2nii:MainPage#Spatial_Coordinates)
134122

135123
![image](https://www.nitrc.org/plugins/mwiki/images/thumb/8/8e/Dcm2nii%3AMni_v_dicom.jpg/300px-Dcm2nii%3AMni_v_dicom.jpg)

0 commit comments

Comments
 (0)