Skip to content

Commit

Permalink
fill up the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
htwangtw committed May 17, 2024
1 parent 760f499 commit c2dd410
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion giga_connectome/denoise.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,16 @@ def is_ica_aroma(strategy: STRATEGY_TYPE) -> bool:
def denoise_meta_data(strategy: STRATEGY_TYPE, img: str) -> METADATA_TYPE:
"""Get metadata of the denoising process.
Including: column names of the confound regressors, number of
volumes discarded by motion scrubbing, number of volumes discarded
by non-steady states detector, mean framewise displacement and
place holder for sampling frequency (1/TR).
Parameters
----------
strategy : dict
Denoising strategy parameter to pass to load_confounds_strategy.
Denoising strategy parameter to pass to load_confounds_strategy
or load_confounds.
img : str
Path to the nifti image to denoise.
Expand Down

0 comments on commit c2dd410

Please sign in to comment.