Skip to content

Commit 402f6d0

Browse files
committed
Add some more context
1 parent d112447 commit 402f6d0

10 files changed

Lines changed: 42 additions & 30 deletions

File tree

src/rbc/anatomical/__init__.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
"""Anatomical preprocessing.
22
3-
This module defines anatomical MRI preprocessing steps for RBC datasets,
4-
including:
3+
This module defines anatomical MRI preprocessing steps for RBC pipeline.
54
6-
- Initial anatomical preprocessing
7-
- Tissue segmentation using FSL FAST
5+
Anatomical preprocessing prepares T1-weighted structural brain images for
6+
analysis. The T1 provides high-resolution anatomy used to align functional
7+
data and identify tissue types (gray matter, white matter, CSF).
8+
9+
Steps: reorientation, skull stripping (ANTs), N4 bias correction, tissue
10+
segmentation (FSL FAST), and registration to MNI152 template.
811
"""

src/rbc/cli/__init__.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
"""Command line interface.
22
3-
This module handles CLI entry points.
3+
This module handles CLI entry points for the RBC pipeline.
4+
5+
Parses arguments, validates BIDS inputs, and dispatches to workflow modules.
6+
Subcommands are defined in rbc.cli.* modules.
47
"""

src/rbc/cli/anatomical.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
"""Anatomical preprocessing.
1+
"""Anatomical preprocessing CLI.
22
3-
This module handles CLI for anatomical preprocessing workflows.
3+
Command-line interface for anatomical preprocessing workflows.
4+
Calls into rbc.workflows.anatomical.
45
"""

src/rbc/cli/derivatives.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
"""Derivative computations.
1+
"""Derivative computations CLI.
22
3-
This module handles CLI for derivative computations.
3+
Command-line interface for computing derivatives (ALFF/fALFF, ReHo, network
4+
centrality, atlas-based timeseries) from preprocessed data.
45
"""

src/rbc/cli/functional.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
"""Functional preprocessing.
1+
"""Functional preprocessing CLI.
22
3-
This module handles CLI for functional preprocessing workflows.
3+
Command-line interface for functional preprocessing workflows.
4+
Requires anatomical preprocessing to have been run first.
45
"""

src/rbc/cli/longitudinal.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
"""Longitudinal CLI.
22
3-
This module handles the longitudinal CLI.
3+
Command-line interface for longitudinal workflows. Creates within-subject
4+
templates and processes multiple sessions.
45
"""

src/rbc/cli/qc.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
"""Quality control CLI.
22
3-
This module handles CLI for QC metrics.
3+
Command-line interface for computing QC metrics. Outputs reports with
4+
pass/fail flags based on RBC thresholds.
45
"""

src/rbc/functional/__init__.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
"""Functional preprocessing.
22
3-
This module defines functional MRI preprocessing steps for RBC datasets,
4-
including:
3+
This module defines functional MRI preprocessing steps for RBC datasets.
54
6-
- Functional initialization
7-
- Motion correction
8-
- Slice timing correction
9-
- Despiking
10-
- BOLD brain masking
11-
- Boundary-based registration (BBR) coregistration
12-
- Single-step resampling to template space
5+
Functional MRI measures brain activity over time via the BOLD signal. Raw
6+
fMRI contains motion artifacts, timing differences, and distortions that
7+
must be corrected before analysis.
8+
9+
Steps: reorientation, TR truncation, motion correction (mcflirt), slice
10+
timing correction (3dTshift), despiking (3dDespike), brain masking,
11+
coregistration to T1w (FLIRT BBR), and single-step resampling to 2mm MNI
12+
space.
1313
"""

src/rbc/longitudinal/__init__.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
"""Longitudinal workflow.
22
3-
This module handles the longitudinal workflow.
3+
This module handles longitudinal preprocessing for multi-session data.
4+
5+
Creates an unbiased within-subject anatomical template and processes each
6+
session relative to it, improving sensitivity for detecting changes over
7+
time in developmental studies.
48
"""

src/rbc/qc/__init__.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
"""Quality control.
22
3-
This module defines quality control metrics for RBC datasets,
4-
including:
3+
This module defines quality control metrics for RBC datasets.
54
6-
- XCP-style quality control outputs
7-
- Motion-related QC metrics
8-
- DVARS and motion–DVARS correlation measures
9-
10-
All metrics are evaluated using RBC-recommended thresholds.
5+
Computes framewise displacement (FD), DVARS, motion-DVARS correlation, and
6+
tSNR. Metrics are evaluated against RBC-recommended thresholds from Shafiei
7+
et al. (2024). Outputs follow XCP-style formatting.
118
"""

0 commit comments

Comments
 (0)