Documentation
Programs
Every program and module LARMORX ports, grouped by the software it comes from. Open a group to see what each program does, which ports it has and how far each port is validated.
Each program has two pages. Its reference says what it does, its command line, its Python call, its options and examples. Its evidence shows how its ports compare with the original, in figures: how the cases of its records agree with the original, how the differences that remain compare with the original’s own variability, what it does on real data, and its speed where a benchmark report exists. The main repository’s code draws every figure from a committed record (docs/figures.md), and its provenance is linked beneath it. So far bet, bet2 and betsurf have their reference page; the others link their API page in the repository until theirs is written.
A port is a replica, translated from the original’s source to give its results bit for bit, or a clean room, written without that source and built for speed; some programs have both (what the words mean). Each port’s status is the one its record states:
- experimental: the tests of its part pass, but the extensive tests of the final validation phase (the data panel, long random-testing runs, the full comparison) are still to come; or a case of its record still fails;
- validated: every case of its record passes, and those extensive tests have been run;
- stable: validated, and its Python and command-line interface no longer change.
From now on a port’s part leaves it experimental, even where every case of its record agrees, and the final validation phase makes it validated. The ports marked validated before this definition (2026-11-12) keep their status, since every case of their record passed: ANTs’ programs, which have their data panel since 2026-10-27, and others, among them most of AFNI’s, sdcflows’ and the replicas of mcflirt and bet (the full list). The final validation phase gives them the rest of the evidence. Most ports since 2026-10-28 were left experimental even where every case agrees. In full: what each status means.
ANTs and ITK
13 programs and 1 modulecompared with ANTs 2.6.5 on ITK 5.4.5replica larmorx Apache-2.0
-
antsRegistrationprogramantsRegistrationregisters one image to another, stage by stage.larmorx ants antsRegistrationlx.ants.registration- replica validated
-
N4BiasFieldCorrectionprogramN4BiasFieldCorrectionremoves a smooth intensity bias field from an image.larmorx ants N4BiasFieldCorrectionlx.ants.n4_bias_field_correction- replica validated
-
DenoiseImageprogramDenoiseImagedenoises an image by adaptive non-local means.larmorx ants DenoiseImagelx.ants.denoise_image- replica validated
-
antsApplyTransformsprogramantsApplyTransformsresamples an image onto the grid of a reference image through a chain of ITK transforms (linear transforms, displacement fields, B-spline transforms and composites of them), or writes the chain itself as one transform.larmorx ants antsApplyTransformslx.ants.apply_transforms- replica validated
-
ImageMathprogramImageMathapplies one operation to an image (and to a second image or numbers): arithmetic, intensity clipping and scaling, Gaussian filters, binary and grayscale morphology, hole filling, padding, connected components and distance maps.larmorx ants ImageMathlx.ants.image_math- replica validated
-
ThresholdImageprogramThresholdImagesets the voxels between two bounds to one value and the others to another, or labels an image’s classes by Otsu’s thresholds.larmorx ants ThresholdImagelx.ants.threshold_image- replica validated
-
MultiplyImagesprogramMultiplyImagesmultiplies an image by another image or by a number.larmorx ants MultiplyImageslx.ants.multiply_images- replica validated
-
SmoothImageprogramSmoothImagesmooths an image with a Gaussian of a given sigma, in voxels or in millimetres, or filters it with a median over a box of a given radius.larmorx ants SmoothImagelx.ants.smooth_image- replica validated
-
ResampleImageprogramResampleImageresamples an image onto a grid with a new spacing or a new size, keeping its origin and direction, by linear, nearest-neighbour, Gaussian, windowed-sinc or B-spline interpolation, and writes it in one of ANTs’ eight pixel types.larmorx ants ResampleImagelx.ants.resample_image- replica validated
-
ResampleImageBySpacingprogramResampleImageBySpacingresamples an image onto a grid with a new spacing, keeping its origin and direction, after smoothing it with a Gaussian where the spacing grows, by linear or nearest-neighbour interpolation.larmorx ants ResampleImageBySpacinglx.ants.resample_image_by_spacing- replica validated
-
antsAIprogramantsAIfinds the linear transform that best aligns two images.larmorx ants antsAIlx.ants.ai- replica validated
-
antsAffineInitializerprogramantsAffineInitializerfinds an affine transform that aligns two images.larmorx ants antsAffineInitializerlx.ants.affine_initializer- replica validated
-
AtroposprogramAtropossegments an image into tissue classes by a finite mixture model with a Markov random field prior.larmorx ants Atroposlx.ants.atropos- replica validated
-
transforms-hdf5moduleITK’s transform files, text, MATLAB and HDF5 (
.h5), read and written in pure Rust.lx.transforms.readcompared with ITK 5.4.5 on HDF5 1.12.1
- replica validated
AFNI
4 programscompared with AFNI 26.3.05replica larmorx Apache-2.0, with AFNI's CC BY 4.0 creditclean room larmorx Apache-2.0
-
3dTshiftprogram3dTshiftcorrects slice timing: it aligns every slice of a 4D series to one time origin.larmorx afni 3dTshiftlx.afni.tshift- replica validated
- clean room validated
-
3dAutomaskprogram3dAutomaskmakes a brain mask from an EPI series or a skull-stripped anatomical image.larmorx afni 3dAutomasklx.afni.automask- replica validated
- clean room validated
-
3dUnifizeprogram3dUnifizemakes the white-matter intensity of a T1-weighted volume uniform across space and scales it to about 1000 (or, with-T2, of a T2-weighted one; with-EPI, of an EPI series).larmorx afni 3dUnifizelx.afni.unifize- replica validated
- clean room validated
-
3dvolregprogram3dvolregregisters every volume of a series to a base volume with a rigid-body (6-parameter) transform.larmorx afni 3dvolreglx.afni.volreg- replica validated
- clean room experimental
FSL
26 programscompared with FSL 6.0.7.23replica larmorx-nc FSL Licence: non-commercial use onlyclean room larmorx Apache-2.0
-
mcflirtprogrammcflirtcorrects head motion in a 4D series.larmorx fsl mcflirtlarmorx mri hmclx.mri.hmc- replica validated
- clean room experimental
-
betprogrambetfinds the brain in a head image.larmorx fsl betlx.fsl.bet- replica validated
- clean room experimental
-
bet2programbet2is FSL’s brain extraction itself, which thebetscript runs.larmorx fsl bet2lx.fsl.bet2- replica validated
- clean room experimental
-
betsurfprogrambetsurffinds the inner skull, the outer skull and the scalp of a head, frombet2’s brain surface (-e), the T1 image (and a T2) and the T1’s registration to MNI152.larmorx fsl betsurflx.fsl.betsurf- replica validated
- clean room experimental
-
flirtprogramflirtregisters one image to another with an affine transform, with every cost function and boundary-based registration (BBR).larmorx fsl flirtlx.fsl.flirt- replica experimental
- clean room experimental
-
convert_xfmprogramconvert_xfmis FLIRT’s matrix tool: it inverts a 4 × 4 matrix (-inverse), composes two (-concat) and gives a matrix another’s scales and skews (-fixscaleskew).larmorx fsl convert_xfmlx.fsl.convert_xfm- replica experimental
- clean room experimental
-
avscaleprogramavscaletakes a FLIRT matrix apart: its rotation and translation, angles, scales, skews, determinant and half transforms.larmorx fsl avscalelx.fsl.avscale- replica experimental
- clean room experimental
-
img2imgcoordprogramimg2imgcoordmaps coordinates from one image to another through a FLIRT matrix: voxels by default, millimetres with-mm.larmorx fsl img2imgcoordlx.fsl.img2imgcoord- replica experimental
- clean room experimental
-
std2imgcoordprogramstd2imgcoordmaps coordinates from a standard image to an image through the inverse of a FLIRT matrix: millimetres by default, the image’s voxels with-vox.larmorx fsl std2imgcoordlx.fsl.std2imgcoord- replica experimental
- clean room experimental
-
img2stdcoordprogramimg2stdcoordmaps coordinates from an image to a standard image through a FLIRT matrix: input voxels by default, output in the standard image’s millimetres.larmorx fsl img2stdcoordlx.fsl.img2stdcoord- replica experimental
- clean room experimental
-
rmsdiffprogramrmsdiffmeasures how far apart two FLIRT matrices are: the RMS deviation in millimetres over 80 mm about the reference’s centre of gravity or, with a mask, the largest and the RMS displacement over the mask’s voxels.larmorx fsl rmsdifflx.fsl.rmsdiff- replica experimental
- clean room experimental
-
makerotprogrammakerotwrites the 4 × 4 matrix of a rotation bythetadegrees about an axis through a centre (or through the centre of an image).larmorx fsl makerotlx.fsl.makerot- replica experimental
- clean room experimental
-
midtransprogrammidtransfinds the transform from a template space to the “middle” of several transforms into that space.larmorx fsl midtranslx.fsl.midtrans- replica experimental
- clean room experimental
-
pointflirtprogrampointflirtfinds the affine matrix that maps one set of points onto another, in the least-squares sense.larmorx fsl pointflirtlx.fsl.pointflirt- replica experimental
- clean room experimental
-
applyxfm4Dprogramapplyxfm4Dresamples each volume of a series onto a reference’s grid, through one matrix or one per volume.larmorx fsl applyxfm4Dlx.fsl.applyxfm4d- replica experimental
- clean room experimental
-
pairregprogrampairregis a script that registers one brain to another and refines the result with the two heads’ skulls.larmorx fsl pairreglx.fsl.pairreg- replica experimental
- clean room experimental
-
extracttxtprogramextracttxtis a script that prints the lines of a text file from the first line that matches a word.larmorx fsl extracttxtlx.fsl.extracttxt- replica experimental
- clean room experimental
-
aff2rigidprogramaff2rigidis a script that turns FLIRT’s 12-parameter matrix from an image to standard space into a 6-parameter (rigid) one.larmorx fsl aff2rigidlx.fsl.aff2rigid- replica experimental
- clean room experimental
-
fastprogramfastsegments a skull-stripped brain image into tissue classes (by default CSF, grey matter and white matter) with a hidden Markov random field fitted by expectation-maximisation.larmorx fsl fastlx.fsl.fast- replica experimental
- clean room experimental
-
topupprogramtopupestimates the off-resonance field (Hz) that displaces echo-planar images along their phase encoding, from two or more images acquired with different phase encodings (typically “blip up” and “blip down”), with each image’s rigid-body movement if asked.larmorx fsl topuplx.fsl.topup- replica experimental
- clean room experimental
-
applytopupprogramapplytopupcorrects images with topup’s result, by Jacobian modulation of each image or by the least-squares restoration of pairs with opposite phase encodings.larmorx fsl applytopuplx.fsl.applytopup- replica experimental
- clean room experimental
-
fslmathsprogramfslmathsreads one image, applies a chain of operations to it from left to right and writes the result.larmorx fsl fslmathslx.fsl.fslmaths- replica experimental
- clean room experimental
-
fslstatsprogramfslstatsprints statistics of an image, per volume, per label or as JSON.larmorx fsl fslstatslx.fsl.fslstats- replica experimental
- clean room experimental
-
fslroiprogramfslroitakes a box of an image (xmin xsize ymin ysize zmin zsize), a range of its volumes (tmin tsize) or both.larmorx fsl fslroilx.fsl.fslroi- replica validated
- clean room experimental
-
standard_space_roiprogramstandard_space_roiis a script that masks an image or cuts it down with a region of a standard space.larmorx fsl standard_space_roilx.fsl.standard_space_roi- replica validated
- clean room experimental
-
preludeprogrampreludeunwraps a phase image (radians) inside a mask.larmorx fsl preludelx.fsl.prelude- replica experimental
- clean room experimental
tedana
1 programcompared with tedana 26.0.3replica larmorx-gpl GPL-3.0clean room larmorx Apache-2.0 from the next release
sdcflows
1 program and 3 modulescompared with sdcflows 2.17.1, with niworkflows 1.15.4 and pybids 0.22.0replica larmorx Apache-2.0
-
sdcflowsprogramsdcflowsfinds the field-map estimators of a BIDS dataset (PEPOLAR, direct and fieldmap-less), runs their workflows and writes their derivatives:larmorx sdcflows sdcflowslx.sdcflows.run_app- replica validated
-
fieldmapmodulesdcflows’ B-spline field fit, the field evaluated and applied, and the phase-difference preparation.
lx.sdcflows- replica validated
-
niworkflows-helpersmoduleThe interfaces of niworkflows that sdcflows’ and fMRIPrep’s field-map steps run.
lx.niworkflowscompared with niworkflows 1.15.4
- replica validated
-
bidsmoduleA BIDS dataset’s index, as pybids’
BIDSLayoutgives it, in memory, without its database.lx.bidscompared with pybids 0.22.0
- replica validated
fMRIPrep
1 program and 5 modulescompared with fMRIPrep's own steps, and the libraries they callreplica larmorx Apache-2.0
-
resample-seriesmodulefMRIPrep’s one-shot resampler: head motion, susceptibility distortion and the transforms to a target space applied to a BOLD series in one cubic interpolation.
lx.transforms.resample_seriescompared with fMRIPrep’s
ResampleSeries, nitransforms 25.1.0, SciPy 1.18.1- replica validated
-
fieldmap-stepsmodulefMRIPrep’s steps between sdcflows’ field-map estimators and the one-shot resampler: the field map evaluated on a reference’s grid, and the distortion parameters.
lx.transforms.reconstruct_fieldmapcompared with fMRIPrep 25.2.7
- replica experimental
-
confoundsmodulefMRIPrep’s confound estimation, ported step by step: CompCor, DVARS, framewise displacement, the motion parameters and the rest of fMRIPrep’s confounds file.
lx.confoundscompared with nipype 1.12.0, niworkflows 1.15.4 and fMRIPrep 25.2.7
- replica experimental from the next release
-
nipypecli runprogramnipypecli runlists a module’s interfaces, prints an interface’s help, and runs one interface from the shell, in the current folder.larmorx nipype runlx.nipype.runcompared with nipype 1.12.0
- replica experimental from the next release
-
ndimage-filtersmoduleSciPy’s ndimage filters, morphology, labelling and watershed, under sdcflows’ and fMRIPrep’s steps.
lx.ndimagecompared with SciPy 1.18.1
- replica validated
-
skimagemodulescikit-image’s ball, Otsu threshold, random walker and histogram matching, under sdcflows’ brain mask.
lx.skimagecompared with scikit-image 0.26.0
- replica validated
LARMORX's own
1 moduleLARMORX's own larmorx Apache-2.0
FreeSurfer
PlannedFreeSurfer 8.2.0Every program complete, a replica in its own package, larmorx-freesurfer, and a clean room built for speed. FreeSurfer's roadmap
Workbench
PlannedConnectome Workbench and MSMSurface tools compatible with Connectome Workbench and MSM. Roadmap
larmorx mri hmc is the clean room of FSL’s mcflirt under a name of its own. larmorx fsl mcflirt runs the replica when larmorx-nc is installed, else the clean room, and larmorx --implementation clean-room fsl mcflirt chooses the clean room (from the next release; in 0.1.0rc1, LARMORX_IMPLEMENTATION=original). tedana’s t2smap has its clean room from the next release; 0.1.0rc1 has only its replica, in larmorx-gpl. fMRIPrep’s confound estimation (lx.confounds) is ported (roadmap); its reference and evidence pages come next. How the ports are compared with their originals, and what each verdict means: Validation.