nlsam.script

Attributes

`DESCRIPTION`
`EPILOG`

Classes

CustomFormatter

Help message formatter which adds default values to argument help.

Functions

`buildArgsParser`()
`main`()
`main_workaround_joblib`()

Module Contents

nlsam.script.DESCRIPTION = Multiline-String

Show Value

"""
Main script for the NLSAM denoising [1], including the bias correction framework from [2].
"""

nlsam.script.EPILOG = Multiline-String

Show Value

"""
References :

[1] St-Jean, S., Coupe, 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:10.1016/j.media.2016.02.010

[2] Koay CG, Ozarslan E and Basser PJ.
A signal transformational framework for breaking the noise floor and its applications in MRI.
Journal of Magnetic Resonance 2009; 197: 108-119.

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

class nlsam.script.CustomFormatter(prog, indent_increment=2, max_help_position=24, width=None)

Bases: argparse.ArgumentDefaultsHelpFormatter, argparse.RawTextHelpFormatter

Help message formatter which adds default values to argument help.

Only the name of this class is considered a public API. All the methods provided by the class are considered an implementation detail.

nlsam.script.buildArgsParser()

nlsam.script.main()

nlsam.script.main_workaround_joblib()