Clarify doc to differentiate dpp_math with dps mode and dps_math

scilus · Dec 12, 2024 · 60903ad · 60903ad
1 parent 5b464ae
commit 60903ad
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/scripts/scil_tractogram_dpp_math.py b/scripts/scil_tractogram_dpp_math.py
@@ -19,7 +19,8 @@
 
 If endpoints_only and dps mode is set operation will be calculated across the
 data at the endpoints and stored as a single value (or array in the 4D case)
-per streamline.
+per streamline. If you wish to perform operations on dps values, please use
+scil_tractogram_dps_math.py.
 
 Endpoint only operation:
 correlation: correlation calculated between arrays extracted from streamline

diff --git a/scripts/scil_tractogram_dps_math.py b/scripts/scil_tractogram_dps_math.py
@@ -6,6 +6,10 @@
 file. Can be for example SIFT2 weights, processing information, bundle IDs,
 tracking seeds, etc.
 
+This script is not the same as the dps mode of scil_tractogram_dpp_math.py,
+which performs operations on dpp (data_per_point) and saves the result as dps.
+Instead this script performs operations directly on dps values.
+
 Input and output tractograms must be .trk, unless you are using the 'import'
 operation, in which case a .tck input tractogram is accepted.