Skip to content

Commit 736011b

Browse files
Remi-GauRemi-Gau
committed
update doc
1 parent 42dbc37 commit 736011b

7 files changed

Lines changed: 145 additions & 2 deletions

File tree

‎docs/bidspm-manual.pdf‎

2.4 KB
Binary file not shown.

‎docs/source/dev_doc.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -394,6 +394,14 @@ bids_model
394394
.. autofunction:: src.bids_model.getInclusiveMask
395395

396396

397+
.. _cli:
398+
399+
cli
400+
===
401+
.. _getOptionsFromCliArgument:
402+
.. autofunction:: src.cli.getOptionsFromCliArgument
403+
404+
397405
.. _defaults:
398406

399407
defaults

‎docs/source/examples/bidspm.bib‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
@software{bidspm,
2+
author = {Gau, Rémi and Barilari, Marco and Battal, Ceren and Rezk, Mohamed and Collignon, Olivier and Gurtubay, Ane and Falagiarda, Federica and MacLean, Michèle and Cerpelloni, Filippo and Shahzad, Iqra and Nunes, Márcia and Caron-Guyon, Jeanne and Chouinard-Leclaire, Christine and Yang, Ying and Mattioni, Stefania},
3+
license = {GPL-3.0},
4+
title = {bidspm},
5+
url = {https://github.com/cpp-lln-lab/bidspm},
6+
version = {2.3.0}
7+
doi = {10.5281/zenodo.3554331},
8+
publisher = {Zenodo},
9+
journal = {Software}
10+
}
11+
12+
@article{Corbin2018,
13+
author = {Corbin, Nadège and Todd, Nick and Friston, Karl J. and Callaghan, Martina F.},
14+
title = {Accurate modeling of temporal correlations in rapidly sampled fMRI time series},
15+
journal = {Human Brain Mapping},
16+
volume = {39},
17+
number = {10},
18+
pages = {3884-3897},
19+
doi = {10.1002/hbm.24218},
20+
year = {2018}
21+
}

‎docs/source/examples/preprocess_citation.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## Pre processing
2+
3+
The (f)MRI data were pre-processed with bidspm (v2.3.0; https://github.com/cpp-lln-lab/bidspm; DOI: https://doi.org/10.5281/zenodo.3554331 - [@bidspm])
4+
using statistical parametric mapping
5+
(SPM12 - 7771; Wellcome Center for Neuroimaging, London, UK;
6+
https://www.fil.ion.ucl.ac.uk/spm; RRID:SCR_007037)
7+
using MATLAB 9.4.0.813654 (R2018a)
8+
on a unix computer (Linux version 5.15.0-53-generic (buildd@lcy02-amd64-047) (gcc (Ubuntu 11.2.0-19ubuntu1) 11.2.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #59-Ubuntu SMP Mon Oct 17 18:53:30 UTC 2022
9+
)
10+
.
11+
12+
13+
The preprocessing of the functional images was performed in the following order:
14+
- removing of dummy scans
15+
- slice timing correction
16+
- realignment and unwarping
17+
- segmentation and skullstripping
18+
- normalization MNI space
19+
- smoothing
20+
21+
{{nb}} dummy scans were removed to allow for signal stabilization.
22+
23+
Slice timing correction was performed
24+
taking the ^th slice as a reference
25+
(interpolation: sinc interpolation).
26+
27+
Functional scans from each participant were realigned and unwarped using the mean image as a reference
28+
(SPM single pass; number of degrees of freedom: 6 ;
29+
cost function: least square) (Friston et al, 1995).
30+
31+
The anatomical image was bias field corrected.
32+
The bias field corrected image was segmented and normalized to
33+
MNI space
34+
(target space: IXI549Space;
35+
target resolution: 1 mm;
36+
interpolation: 4th degree b-spline)
37+
using a unified segmentation.
38+
39+
The tissue propability maps generated by the segmentation
40+
were used to skullstripp the bias corrected image removing any voxel with
41+
p(gray matter) + p(white matter) + p(CSF) > 0.75.
42+
43+
The mean functional image obtained from realignement was co-registered to the
44+
bias corrected anatomical image
45+
(number of degrees of freedom: 6 ;
46+
cost function: normalized mutual information)
47+
(Friston et al, 1995).
48+
The transformation matrix from this coregistration was applied to all the functional images.
49+
50+
The deformation field obtained from the segmentation was applied to all the functional images
51+
(target space: IXI549Space;
52+
target resolution: equal to that used at acquisition;
53+
interpolation: 4th degree b-spline).
54+
55+
Preprocessed functional images were spatially smoothed using a 3D
56+
gaussian kernel (FWHM = 6 mm).
57+
58+
## References
59+
60+
This method section was automatically generated using bidspm
61+
(v2.3.0; https://github.com/cpp-lln-lab/bidspm; DOI: https://doi.org/10.5281/zenodo.3554331)
62+
and octache (https://github.com/Remi-Gau/Octache).

‎docs/source/examples/stats_model-resampling_citation.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## fMRI statistical analysis
2+
3+
The fMRI data were analysed with bidspm (v2.3.0; https://github.com/cpp-lln-lab/bidspm; DOI: https://doi.org/10.5281/zenodo.3554331 - [@bidspm])
4+
using statistical parametric mapping
5+
(SPM12 - 7771; Wellcome Center for Neuroimaging, London, UK;
6+
https://www.fil.ion.ucl.ac.uk/spm; RRID:SCR_007037)
7+
using MATLAB 9.4.0.813654 (R2018a)
8+
on a unix computer (Linux version 5.15.0-53-generic (buildd@lcy02-amd64-047) (gcc (Ubuntu 11.2.0-19ubuntu1) 11.2.0, GNU ld (GNU Binutils for Ubuntu) 2.38) #59-Ubuntu SMP Mon Oct 17 18:53:30 UTC 2022
9+
)
10+
11+
The input data were the preprocessed BOLD images in IXI549Space space for the task " facerepetition ".
12+
13+
### Run / subject level analysis
14+
15+
At the subject level, we performed a mass univariate analysis with a linear
16+
regression at each voxel of the brain, using generalized least squares with a
17+
global AR(1) model to account for temporal auto-correlation
18+
and a drift fit with discrete cosine transform basis ( 128 seconds cut-off).
19+
20+
Image intensity scaling was done run-wide before statistical modeling such that
21+
the mean image would have a mean intracerebral intensity of 100.
22+
23+
We modeled the fMRI experiment in a event design with regressors
24+
entered into the run-specific design matrix. The onsets
25+
were convolved with SPM canonical hemodynamic response function (HRF)
26+
and its temporal and dispersion derivatives for the conditions:
27+
- `famous_1`,
28+
- `famous_2`,
29+
- `unfamiliar_1`,
30+
- `unfamiliar_2`,
31+
.
32+
33+
Nuisance covariates included:
34+
35+
- `trans_?`,
36+
- `rot_?`,
37+
38+
to account for residual motion artefacts,
39+
.
40+
41+
42+
43+
## References
44+
45+
This method section was automatically generated using bidspm
46+
(v2.3.0; https://github.com/cpp-lln-lab/bidspm; DOI: https://doi.org/10.5281/zenodo.3554331)
47+
and octache (https://github.com/Remi-Gau/Octache).

‎setup.cfg‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ dev =
4646
%(demo)s
4747
%(doc)s
4848
%(style)s
49+
cffconvert
4950
ruamel.yaml
5051
doc =
5152
myst-parser
@@ -68,4 +69,9 @@ style =
6869
[flake8]
6970
max-line-length = 99
7071
max-complexity = 10
71-
ignore = F841
72+
ignore = F841, D100, D101, D103, D104
73+
exclude =
74+
*build
75+
.git
76+
__pycache__
77+
tests/*

‎src/parsers.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414

1515
def bidspm_log(name: str = "bidspm") -> logging.Logger:
1616
"""Create log."""
17-
1817
FORMAT = "bidspm - %(asctime)s - %(levelname)s - %(message)s"
1918

2019
if not name:

0 commit comments

Comments
 (0)