8000 Adding a section on estimators by Shotgunosine · Pull Request #375 · poldracklab/fitlins · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

Adding a section on estimators #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jul 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/conf.py
10000
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@

source_suffix = ['.rst', '.md']

intersphinx_mapping = {
'nilearn': ('https://nilearn.github.io/stable/', None),
'afni': ('https://afni.nimh.nih.gov/pub/dist/doc/htmldoc/', None)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh. That's really cool.

}

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
43 changes: 43 additions & 0 deletions docs/estimators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.. include:: links.rst

Estimators
==========

When fitting hierarchical models, there are two broad classes of estimators:
time-series estimators, which accept a time series and a design matrix
and produce statistical maps;
and summary-statistic estimators, which accept a collection of statistical maps
and a design matrix, and produce statistical maps.
Time-series estimators fit models that are often called "first-level" or "run-level"
models, and summary-statistic estimators fit models that are often called "second-level"
or perhaps "subject-level" or "group-level".


Time-series estimators
----------------------
Fitlins supports two estimators for first-level models:
Nilearn's :py:class:`~nilearn.glm.first_level.FirstLevelModel`
and AFNI's :ref:`3dREMLfit<afni:ahelp_3dremlfit>`.
In both cases, the design matrix is generated by PyBIDS and Nilearn.
You can select the AFNI estimator by passing ``--estimator afni`` to FitLins.

Nilearn
~~~~~~~
Fits a normal general linear model (GLM) assuming that the residuals are not autocorrelated.
This is quick and no-frills.

AFNI
~~~~
Fits a "prewhitened" GLM with an ARMA(1,1) model to each voxel to account for autocorrelated time series noise.
The GLM and the ARMA(1,1) model are simultaneously optimized with a restricted maximum likelihood approach.
The downside of the approach is that it's a bit slower as it has to iteratively fit the GLM and ARMA model at each voxel.


Summary statistic estimators
----------------------------
For ``"glm"`` model types, FitLins currently only supports Nilearn's
:py:class:`~nilearn.glm.second_level.SecondLevelModel` estimator.

For ``"meta"`` model types, FitLins uses Nilearn's
:py:func:`~nilearn.glm.compute_fixed_effects` to compute a fixed-effects
combination.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Contents
installation
usage
model
estimators
examples/index
changes
support
Expand Down
Loading
0