Skip to main content

Implementation of "Non Local Spatial and Angular Matching : Enabling higher spatial resolution diffusion MRI datasets through adaptive denoising"

Project description

Non Local Spatial and Angular Matching (NLSAM) denoising

The reference implementation for the Non Local Spatial and Angular Matching (NLSAM) denoising algorithm for diffusion MRI.

Quick links

You can find the latest documentation and installation instructions over here with a downloadable version of the documentation here.

How to install

If you have a working python setup already, the next command should give you everything you need.

pip install nlsam

You can also download the datasets used in the paper over here.

Using the NLSAM algorithm

The process is to first transform your data to Gaussian distributed signals if your dataset is Rician or Noncentral chi distributed and then proceed to the NLSAM denoising part itself.

A quickstart example call would be

nlsam_denoising dwi.nii.gz dwi_nlsam.nii.gz bvals bvecs -m mask.nii.gz

For more fine grained control and explanation of arguments, have a look at the possible command line options with nlsam_denoising --help

You can find a detailed usage example and assorted dataset to try out in the example folder.

Questions / Need help / Think this is great software?

If you need help or would like more information, don't hesitate to drop me a line at samuel.st_jean@university, where university needs to be replaced with med.lu.se

References

The NLSAM denoising algorithm itself is detailed in

St-Jean, S., Coupé, P., & Descoteaux, M. (2016). "Non Local Spatial and Angular Matching : Enabling higher spatial resolution diffusion MRI datasets through adaptive denoising" Medical Image Analysis, 32(2016), 115–130. DOI URL

The bias correction framework is a reimplementation of

Koay, CG, Özarslan, E and Basser, PJ A signal transformational framework for breaking the noise floor and its applications in MRI, Journal of Magnetic Resonance, Volume 197, Issue 2, 2009

The automatic estimation of the noise distribution is computed with

St-Jean S, De Luca A, Tax C.M.W., Viergever M.A, Leemans A. (2020) "Automated characterization of noise distributions in diffusion MRI data." Medical Image Analysis, October 2020:101758. doi:10.1016/j.media.2020.101758

And here is a premade bibtex entry.

@article{St-Jean2016a,
  author = {St-Jean, Samuel and Coup{\'{e}}, Pierrick and Descoteaux, Maxime},
  doi = {10.1016/j.media.2016.02.010},
  journal = {Medical Image Analysis},
  pages = {115--130},
  title = {{Non Local Spatial and Angular Matching : Enabling higher spatial resolution diffusion MRI datasets through adaptive denoising}},
  volume = {32},
  year = {2016}
  }

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nlsam-0.7.2.tar.gz (42.1 MB view hashes)

Uploaded Source

Built Distributions

nlsam-0.7.2-cp312-cp312-win_amd64.whl (272.3 kB view hashes)

Uploaded CPython 3.12 Windows x86-64

nlsam-0.7.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

nlsam-0.7.2-cp312-cp312-macosx_11_0_arm64.whl (295.1 kB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

nlsam-0.7.2-cp312-cp312-macosx_10_9_x86_64.whl (340.6 kB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

nlsam-0.7.2-cp311-cp311-win_amd64.whl (280.8 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

nlsam-0.7.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

nlsam-0.7.2-cp311-cp311-macosx_11_0_arm64.whl (295.0 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

nlsam-0.7.2-cp311-cp311-macosx_10_9_x86_64.whl (344.5 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

nlsam-0.7.2-cp310-cp310-win_amd64.whl (279.2 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

nlsam-0.7.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

nlsam-0.7.2-cp310-cp310-macosx_11_0_arm64.whl (294.9 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

nlsam-0.7.2-cp310-cp310-macosx_10_9_x86_64.whl (345.0 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

nlsam-0.7.2-cp39-cp39-win_amd64.whl (280.5 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

nlsam-0.7.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.28+ x86-64

nlsam-0.7.2-cp39-cp39-macosx_11_0_arm64.whl (295.8 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

nlsam-0.7.2-cp39-cp39-macosx_10_9_x86_64.whl (346.2 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page