Skip to content

Commit

Permalink
Merge pull request #27 from arokem/document_include_order
Browse files Browse the repository at this point in the history
DOC: Document the significance of ROIS order in BundleDict
  • Loading branch information
36000 authored Nov 21, 2024
2 parents cb2e84f + b4f2244 commit 5390957
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions AFQ/api/bundle_dict.py
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,14 @@ class BundleDict(MutableMapping):
"cross_midline": False
}
})
Note
----
The order of include ROIs may affect your results. This is
because ROI order within the include list determines the orientation of the
streamlines (from the first to the last) and the clipping of streamlines
when `clip_edges` is used, because the streamlines are clipped to
between the first and last ROIs.
"""

def __init__(self,
Expand Down

0 comments on commit 5390957

Please sign in to comment.