Skip to content
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

Clarify doc to differentiate dpp_math with dps mode and dps_math #1081

Merged
merged 1 commit into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion scripts/scil_tractogram_dpp_math.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions scripts/scil_tractogram_dps_math.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down