Skip to content

Commit 9a17fb1

Browse files
authored
Update README.md
1 parent 606b667 commit 9a17fb1

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
@@ -79,6 +79,17 @@ Before running the Docker container, here are the available options for the `Doc
7979

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

82+
## Options
83+
Before running the Docker container, here are the available options for the `Docker image` script:
84+
85+
- `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.
86+
- `output`: Path to the output directory for the converted NIfTI files and sidecar BIDS JSON.
87+
- ` -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.
88+
- ` -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.
89+
- ` -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.
90+
91+
92+
8293
### Example usage
8394

8495
```sh
@@ -105,29 +116,6 @@ sudo docker run -it --rm --name TF2.4_IVIM-MRI_CodeCollection \
105116
/usr/src/app/dicom_file -o /usr/app/output -s
106117
```
107118

108-
#### Required parameters
109-
110-
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.
111-
112-
output: Path to the output directory for the converted NIfTI files.
113-
114-
#### Optional Flags
115-
116-
#### -m, --merge-2d
117-
118-
Merge 2D slices into a 3D or 4D NIfTI image regardless of study time, echo, coil, orientation, etc.
119-
Depending on your vendor, you may want to keep images segmented based on these attributes or merge/combine them.
120-
121-
#### -s, --single-file
122-
123-
Use single file mode (convert only one series per folder).
124-
125-
For example, if the input path "~/dir/001.dcm" will only convert the file 001.dcm.
126-
127-
#### -pu, --prompt-user
128-
129-
Run the tool in interactive mode. This launches a terminal-based wizard where you can select DICOM folders and configure conversion interactively.
130-
131119
[Note that NIfTI and DICOM encode space differently](https://www.nitrc.org/plugins/mwiki/index.php/dcm2nii:MainPage#Spatial_Coordinates)
132120

133121
![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)