Python API

One page per public package, generated from the docstrings. A name is public when it is in its package’s __all__; these pages list exactly those names. Import a name from its package, for example from larmor.sd import find_peaks, not from the module that defines it.

Package	What it holds
larmor	The names for the most common tasks, from the packages below
larmor.types	The core data types: grids, volumes, tractograms, surfaces, gradient tables and labels
larmor.io	Loading and saving by path, gradient files, MATLAB files and MRIToolkit results
larmor.io.formats	The reader and writer of each file format
larmor.dwi	Brain masks, denoising, Gibbs ringing removal, and the DTI and DKI models
larmor.sd	Spherical deconvolution: response functions, FODs and their peaks
larmor.tractography	Seeds, the tracker, editing tractograms, track density, connectomes and tract profiles
larmor.registration	Applying and inverting ANTs, FSL and MRtrix3 registrations
larmor.surfaces	Operations on surface meshes
larmor.data	Public example datasets, downloaded on first use
larmor.viewer	BrainViewer from Python

The files each function reads and writes are listed in File formats.