SlicerDMRI / whitematteranalysis

White matter tractography clustering and more...
https://dmri.slicer.org/whitematteranalysis/
Other
69 stars 33 forks source link

Make atlas version being available, pointed and downloaded consistent #126

Open jhlegarreta opened 1 year ago

jhlegarreta commented 1 year ago

The ORG atlases in the ORG-Atlases repository have received a few updates over time, e g. https://github.com/SlicerDMRI/ORG-Atlases/commit/fb1997318c6e8c2ab727601be509e4a4377777cf

Also, the file history in Zenodo shows a few versions: https://zenodo.org/search?page=1&size=20&q=conceptrecid:%222648283%22&sort=-version&all_versions=True

According to its README file, we can download the atlas files manually or automatically using WMA tools (i.e. this repository)

On the one hand, for some reason, the ZIP files (e.g. ORG-Tracts-MRB.zip, ORG-800FiberClusters.zip, ORG-800FC-100HCP.zip) pointed by the README do not correspond to the latest version of the atlas.

On the other hand, the version of the files that the WMA tool downloads is hard-coded: https://github.com/SlicerDMRI/whitematteranalysis/blob/ddb59ded5164376217bdad81b59232a684fee88c/bin/wm_download_anatomically_curated_atlas.py#L81

And it does not correspond to the most recent version available.

Additionally, the documentation for the tractography parcellation step points to the 1.1.1 version of the atlas, e.g.: https://github.com/SlicerDMRI/whitematteranalysis/blob/6d93b6452b32ebedbee29674766abfe752dd1d04/doc/subject-specific-tractography-parcellation.md?plain=1#L23

Finally, the atlas bundle dictionary is hard-coded here: https://github.com/SlicerDMRI/whitematteranalysis/blob/6d93b6452b32ebedbee29674766abfe752dd1d04/bin/wm_append_clusters_to_anatomical_tracts.py#L99

And it has not been updated to the changes in the commit pointed above.

So it is highly likely that the files downloaded manually or using the WMA tool become inconsistent, which may be a problem.

So the files being available, those pointed in the README, and those downloaded by the script should correspond exactly to the same versions to avoid problems.

ljod commented 1 year ago

Thanks for looking at this! Fan can you let us know what version we should all be using? @zhangfanmark

jhlegarreta commented 1 year ago

PRs #132 and #133 address some of these points.