From a262eceae3bd383620da20205ba2c445c80d9fd2 Mon Sep 17 00:00:00 2001 From: Ariel Rokem Date: Fri, 13 Dec 2024 13:47:40 -0800 Subject: [PATCH] Document default scalars The code checks and if the data is multi-shell it produces dki scalars. --- docs/source/reference/kwargs.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/reference/kwargs.rst b/docs/source/reference/kwargs.rst index 71c81e72..c5f56a2f 100644 --- a/docs/source/reference/kwargs.rst +++ b/docs/source/reference/kwargs.rst @@ -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"]. ==========================================================