Skip to content

Commit 8aa61d7

Browse files
authored
Added rules for derivatives files
1 parent a509fed commit 8aa61d7

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/upload.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,21 @@ An example from a (fictional) dataset that includes dMRI and histology data from
112112
sub-Ken2_sample-slice0011_photo.tif
113113
sub-Ken2_sample-slice0011_stain-FR_DF.json
114114
sub-Ken2_sample-slice0011_stain-FR_DF.tif
115+
derivatives/
116+
sub-Ken1/
117+
dwi/
118+
...
119+
scenes/
120+
...
121+
xfms/
122+
...
123+
sub-Ken2/
124+
dwi/
125+
...
126+
scenes/
127+
...
128+
xfms/
129+
...
115130
```
116131

117132
The files and subdirectories in this example dataset are described in detail below.
@@ -171,6 +186,10 @@ This directory contains microscopy data files [as described in detail in the BID
171186

172187
In this example the data include images (`.tif`) and metadata (`.json`) from multiple brain sections. For each section there is a blockface photo (`_photo`) and a histological stain (`_stain`). Sections from Ken1 and Ken2 were either processed with a Nissl stain and imaged under brightfield microscopy (`_BF`), or processed for the fluorescent tracer Lucifer Yellow (`LY`) and imaged under darkfield microscopy (`_DF`). Additional sections from Ken2 were processed for the fluorescent tracer Fluoro-Ruby (`FR`) and imaged under darkfield microscopy (`_DF`).
173188

189+
### derivatives
190+
This directory contains one subdirectory for each brain, which contains one subdirectory for each modality, which in turn contains any data files that were produced by analyzing the raw data of that modality. At the same level as the modality-specific directories, there are also directories for saving files that can be produced by co-analyzing images of more than one modality, e.g., `xfms/` for transform files or `scenes/` for scene files.
191+
192+
The name every image or data file under `derivatives/` must start with a prefix that contains its subject and sample label, e.g., `sub-Ken1_sample-brain_*.nii.gz`, `sub-Ken2_sample-brain_*.trk`, etc.
174193

175194
#### high-res histology annotation
176195
All annotation files use the following naming scheme:

0 commit comments

Comments
 (0)