Skip to content

Commit

Permalink
Document default scalars
Browse files Browse the repository at this point in the history
The code checks and if the data is multi-shell it produces dki scalars.
  • Loading branch information
arokem authored Dec 13, 2024
1 parent f4e51a6 commit a262ece
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/reference/kwargs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,8 @@ scalars: strings and/or scalar definitions, optional
List of scalars to use.
Can be any of: "dti_fa", "dti_md", "dki_fa", "dki_md", "dki_awf",
"dki_mk". Can also be a scalar from AFQ.definitions.image.
Default: ["dti_fa", "dti_md"]
Default: For single shell data: ["dti_fa", "dti_md"],
for multi-shell data: ["dki_fa", "dki_md"].


==========================================================
Expand Down

0 comments on commit a262ece

Please sign in to comment.