Skip to content

Commit 07a8015

Browse files
committed
DOC: U Update --derivatives FAQ
1 parent de1fd0e commit 07a8015

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

docs/faqs.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Leveraging precomputed results
44

5-
Whether to allow for manual intervention for tough cases, or simply to reduce processing time, *NiBabies* can allow the use of certain pre-computed files during processing.
6-
Initial support is limited to the following files:
7-
- Anatomical mask in T1w space
8-
- Antomical segmentation (aseg) in T1w space
5+
Whether manual intervention is required, or you want to reduce processing time, *NiBabies* allow the use of certain pre-computed files during processing, which can skip part of the workflow.
6+
Support is limited to the following files:
7+
- Anatomical mask in T1w or T2w space
8+
- Antomical segmentation (aseg) in T1w or T2w space
99

1010
To use pre-computed results, one or more [BIDS Derivatives](https://bids-specification.readthedocs.io/en/stable/05-derivatives/01-introduction.html#bids-derivatives) directories must be passed in to *NiBabies* using the `--derivatives` flag.
1111
Derivative directories must include a [`dataset_description.json` and the required fields](https://bids-specification.readthedocs.io/en/stable/03-modality-agnostic-files.html#derived-dataset-and-pipeline-description).
12-
Additionally, files must include the `space-orig` key-value pair in the name.
12+
Additionally, files must include the `space-T1w` or `space-T2w` key-value pair in the filenames, and a matching sidecar JSON file with the `SpatialReference` field defined.
1313

1414
A sample layout of a derivatives directory can be found below:
1515

@@ -18,11 +18,19 @@ my_precomputed/
1818
├── dataset_description.json
1919
└── sub-01
2020
└── anat
21-
├── sub-01_space-orig_desc-aseg_dseg.nii.gz
22-
├── sub-01_space-orig_desc-brain_mask.json
23-
└── sub-01_space-orig_desc-brain_mask.nii.gz
21+
├── sub-01_space-T2w_desc-aseg_dseg.json
22+
├── sub-01_space-T2w_desc-aseg_dseg.nii.gz
23+
├── sub-01_space-T2w_desc-brain_mask.json
24+
└── sub-01_space-T2w_desc-brain_mask.nii.gz
2425
```
2526

27+
and the contents of the JSON files:
28+
```
29+
{"SpatialReference": "sub-01/anat/sub-01_T2w.nii.gz"}
30+
```
31+
32+
The `SpatialReference` file will be used to ensure the raw data and the derivatives are aligned and in the same space.
33+
2634
## Multi-atlas segmentation with joint label fusion
2735

2836
By default, *NiBabies* will run [FSL FAST](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FAST) for tissue segmentation, and Infant FreeSurfer for segmentation labels.
@@ -53,4 +61,4 @@ In short, here is a quick heuristic on how new releases should be looked at:
5361
1. If the `YY.MINOR` match the version you used, but the `MICRO` has changed, it is a bug-fix release.
5462
Check the [release notes](https://github.com/nipreps/nibabies/releases) - if the fixes do not pertain to your data, there is no need to upgrade.
5563

56-
For more in-depth information, refer to the [*NiPreps* release documentation](https://www.nipreps.org/devs/releases/#principles).
64+
For more in-depth information, refer to the [*NiPreps* release documentation](https://www.nipreps.org/devs/releases/#principles).

0 commit comments

Comments
 (0)