-
Notifications
You must be signed in to change notification settings - Fork 34
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
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ac7ad1a
Start estimator docs
Shotgunosine e42ab9d
add run instruction to estimators
Shotgunosine 9821ccd
fix whitespace
Shotgunosine a84a9b6
add remlfit to example
Shotgunosine 7b3b172
tweak language describing estimators
Shotgunosine 23df1db
DOC: Describe time-series and summary-statistics estimators
effigies 7073410
UI: Make nistats a deprecated synonym for nilearn
effigies 20045e3
DOC: Note that design matrix generation is largely done by pybids
effigies File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,6 +16,7 @@ Contents | |
installation | ||
usage | ||
model | ||
estimators | ||
examples/index | ||
changes | ||
support | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.