Skip to content

Commit be3eb99

Browse files
Copilotakhanf
andauthored
Update documentation to reflect new output directory structure
Agent-Logs-Url: https://github.com/khanlab/SPIMquant/sessions/5a4d135a-dab2-4314-a50f-6ba49c69f676 Co-authored-by: akhanf <11492701+akhanf@users.noreply.github.com>
1 parent 82efd66 commit be3eb99

3 files changed

Lines changed: 95 additions & 39 deletions

File tree

docs/faq.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,14 +160,16 @@ Cohen's d interpretation:
160160

161161
### Where are my results?
162162

163-
Results are in the output directory under `spimquant/`:
163+
Results are in the output directory under `spimquant/`. Outputs are organized across several subdirectories by type:
164164
```
165165
output/spimquant/
166166
├── sub-01/
167-
│ └── micr/
168-
│ ├── *_space-template_SPIM.nii.gz
169-
│ ├── *_dseg.nii.gz
170-
│ └── *_segstats.tsv
167+
│ ├── micr/ - registered images (*_space-{template}_SPIM.nii.gz) and masks
168+
│ ├── seg/ - full-resolution segmentation data (*_SPIM.ome.zarr)
169+
│ ├── parc/ - atlas parcellation maps (*_from-{template}_dseg.nii.gz)
170+
│ ├── tabular/ - statistics tables (*_segstats.tsv, *_regionpropstats.tsv, etc.)
171+
│ └── xfm/ - registration transforms
172+
└── group/ - group-level results (*_groupstats.tsv, *_groupstats.png, etc.)
171173
```
172174

173175
### What format are the statistics in?

docs/getting_started/quickstart.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -100,22 +100,29 @@ Processing time depends on:
100100
After processing completes, find your results in the output directory:
101101

102102
```
103-
output/
104-
└── spimquant/
105-
├── sub-01/
106-
│ └── micr/
107-
│ ├── sub-01_space-template_SPIM.nii.gz
108-
│ ├── sub-01_space-template_dseg.nii.gz
109-
│ └── sub-01_segstats.tsv
110-
└── qc/
111-
└── sub-01_registration_overlay.png
103+
output/spimquant/
104+
├── sub-01/
105+
│ ├── micr/
106+
│ │ ├── sub-01_sample-brain_acq-4x_stain-YOPRO_space-ABAv3_SPIM.nii.gz
107+
│ │ └── sub-01_sample-brain_acq-4x_mask.nii.gz
108+
│ ├── seg/
109+
│ │ └── sub-01_sample-brain_acq-4x_stain-Abeta_SPIM.ome.zarr
110+
│ ├── parc/
111+
│ │ └── sub-01_sample-brain_acq-4x_seg-ABAv3_from-ABAv3_dseg.nii.gz
112+
│ └── tabular/
113+
│ └── sub-01_sample-brain_acq-4x_seg-ABAv3_from-ABAv3_stain-Abeta_segstats.tsv
114+
└── group/
115+
├── *_groupstats.tsv
116+
└── *_groupstats.png
112117
```
113118

114119
Key output files:
115120

116-
- `*_space-template_SPIM.nii.gz`: Registered SPIM data
117-
- `*_dseg.nii.gz`: Segmentation results
118-
- `*_segstats.tsv`: Quantitative statistics by brain region
121+
- `micr/*_space-{template}_SPIM.nii.gz`: Registered SPIM data in template space
122+
- `seg/*_SPIM.ome.zarr`: Full-resolution segmentation results
123+
- `parc/*_from-{template}_dseg.nii.gz`: Atlas-based parcellation maps
124+
- `tabular/*_segstats.tsv`: Quantitative statistics by brain region
125+
- `group/*_groupstats.tsv`: Group-level statistical results
119126

120127
## Step 6: Generate a Report
121128

docs/reference/outputs.md

Lines changed: 69 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,59 +7,106 @@ Reference for SPIMquant output files and formats.
77
## Directory Structure
88

99
```
10-
output/
11-
└── spimquant/
12-
├── sub-01/
13-
│ └── micr/
14-
│ ├── *_space-template_SPIM.nii.gz
15-
│ ├── *_dseg.nii.gz
16-
│ └── *_segstats.tsv
17-
└── qc/
10+
output/spimquant/
11+
├── sub-01/
12+
│ ├── micr/
13+
│ │ ├── *_space-{template}_SPIM.nii.gz
14+
│ │ ├── *_space-{template}_regqc.html
15+
│ │ └── *_mask.nii.gz
16+
│ ├── seg/
17+
│ │ └── *_SPIM.ome.zarr
18+
│ ├── parc/
19+
│ │ └── *_from-{template}_dseg.nii.gz
20+
│ ├── tabular/
21+
│ │ ├── *_segstats.tsv
22+
│ │ ├── *_regionpropstats.tsv
23+
│ │ ├── *_fieldfracstats.tsv
24+
│ │ └── *_countstats.tsv
25+
│ └── xfm/
26+
│ └── *_xfm.{txt,nii.gz}
27+
└── group/
28+
├── *_groupstats.tsv
29+
├── *_groupstats.png
30+
└── *_groupstats.nii.gz
1831
```
1932

2033
## Participant-Level Outputs
2134

22-
<!-- TODO: Document participant outputs -->
35+
### Registered Images (`micr/`)
2336

24-
### Registered Images
37+
`*_space-{template}_SPIM.nii.gz`
2538

26-
`*_space-template_SPIM.nii.gz`
39+
Registered SPIM data in template space, stored as NIfTI files.
2740

28-
<!-- TODO: Add file format details -->
41+
### Registration QC Reports (`micr/`)
2942

30-
### Segmentation Maps
43+
`*_space-{template}_regqc.html`
3144

32-
`*_dseg.nii.gz`
45+
HTML reports for visually checking registration quality.
3346

34-
<!-- TODO: Add file format details -->
47+
### Brain Masks (`micr/`)
3548

36-
### Statistics Tables
49+
`*_mask.nii.gz`
50+
51+
Binary brain mask in subject space.
52+
53+
### Segmentation Data (`seg/`)
54+
55+
`*_SPIM.ome.zarr`
56+
57+
Full-resolution segmentation results stored as OME-Zarr arrays.
58+
59+
### Parcellation Maps (`parc/`)
60+
61+
`*_from-{template}_dseg.nii.gz`
62+
63+
Atlas-based discrete segmentation (parcellation) maps in subject space.
64+
65+
### Statistics Tables (`tabular/`)
3766

3867
`*_segstats.tsv`
3968

40-
<!-- TODO: Add table format details -->
69+
Per-region segmentation statistics combining region properties, field fraction, and count metrics.
70+
71+
`*_regionpropstats.tsv`
72+
73+
Per-region object-level properties (e.g. volume, centroid).
74+
75+
`*_fieldfracstats.tsv`
76+
77+
Per-region field fraction (percentage of voxels positive) statistics.
78+
79+
`*_countstats.tsv`
80+
81+
Per-region object count statistics.
82+
83+
### Transforms (`xfm/`)
84+
85+
`*_xfm.txt` / `*_xfm.nii.gz`
86+
87+
Affine and deformable registration transforms between subject and template space.
4188

4289
## Group-Level Outputs
4390

44-
<!-- TODO: Document group outputs -->
91+
Group-level outputs are stored directly under `output/spimquant/group/` (no subject subdirectory).
4592

4693
### Statistical Results
4794

4895
`*_groupstats.tsv`
4996

50-
<!-- TODO: Add file format details -->
97+
Statistical test results (t-statistics, p-values, effect sizes) for each brain region.
5198

5299
### Visualizations
53100

54101
`*_groupstats.png`
55102

56-
<!-- TODO: Add visualization details -->
103+
Heatmap visualizations of statistical results across brain regions.
57104

58105
### Volume Maps
59106

60-
`*_groupstats.nii`
107+
`*_groupstats.nii.gz`
61108

62-
<!-- TODO: Add file format details -->
109+
3D volumetric maps of statistical values for visualization in neuroimaging software.
63110

64111
## Quality Control Outputs
65112

0 commit comments

Comments
 (0)