Programs · FSL
rmsdiff
- Original
- FSL 6.0.7.23
- Command line
larmorx fsl rmsdiff- Python
lx.fsl.rmsdiff- Ports
- replica
larmorx-ncFSL Licence: non-commercial use only experimental - clean room
larmorxApache-2.0 experimental
- replica
- Evidence
- every comparison with FSL
- Source
- made from docs/api/fsl-flirt.md and the code
What it does
rmsdiff measures 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.
Command line
larmorx fsl rmsdiff matrixfile1 matrixfile2 refvol [mask]Everything after larmorx fsl rmsdiff is the original’s command line: the arguments of FSL 6.0.7.23’s rmsdiff, as FSL takes them. LARMORX’s own options stand between larmorx and the family fsl, so they never meet the original’s (below):
larmorx
[--n-threads N]
[--implementation auto|replica|clean-room]
[--upstream-defects fix|reproduce]
fsl rmsdiff ...From the next release. In 0.1.0rc1, set the variables instead: OMP_NUM_THREADS, LARMORX_IMPLEMENTATION (original for the clean room) and LARMORX_UPSTREAM_DEFECTS.
rmsdiff's usage text, as the clean room prints it
Usage: rmsdiff matrixfile1 matrixfile2 refvol [mask]
Outputs rms deviation between matrices (in mm)Python
lx.fsl.rmsdiff(
matrix1: Any,
matrix2: Any,
ref: Any,
mask: Any = None,
*,
n_threads: int = 1,
implementation: ImplementationName = "auto",
) -> float | tuple[float, float]Where ImplementationName is one of "auto", "replica", "clean-room", "original" (0.1.0rc1’s spelling of "clean-room").
FSL’s rmsdiff: the RMS deviation (mm) between two matrices (4 x 4 arrays or files) over a sphere of radius 80 mm about ref’s centre of gravity; with mask, the largest and the RMS displacement over the mask’s voxels, as (largest, rms).
Options
Each row joins an option of the original’s command line with the Python argument that does the same. The rows are checked against the code at every test run: the options rmsdiff accepts (crates/larmorx-fsl/src/cli/rmsdiff.rs) and the arguments of lx.fsl.rmsdiff (python/larmorx/fsl/flirt_tools.py), whose defaults and descriptions are taken from it. Under each option, in grey, FSL’s own help for it.
rmsdiff arguments |
Python | Default | Notes |
|---|---|---|---|
matrixfile1 matrixfile2 refvol [mask] |
matrix1, matrix2, ref, mask |
mask=None |
LARMORX’s own options
From the next release. In 0.1.0rc1, set the variables instead: OMP_NUM_THREADS, LARMORX_IMPLEMENTATION (original for the clean room) and LARMORX_UPSTREAM_DEFECTS.
They stand between larmorx and fsl on the command line (larmorx --n-threads 4 fsl rmsdiff ...); lx.fsl.rmsdiff takes n_threads and implementation as arguments, and the other is the command line’s only. Each one given wins over its environment variable, which keeps working.
| Command line, then Python | What it does |
|---|---|
--n-threads Nn_threads=1 |
Threads (0 = all), given to the program as OMP_NUM_THREADS; the result does not depend on it. Default: every logical CPU on the command line (0), 1 in Python. The variable OMP_NUM_THREADS in 0.1.0rc1. |
--implementation auto|replica|clean-roomimplementation="auto" |
"auto" (default): the replica when larmorx-nc is installed, else the clean room; "replica" or "clean-room" ("original", 0.1.0rc1’s spelling, still works). The variable LARMORX_IMPLEMENTATION in 0.1.0rc1. |
--upstream-defects fix|reproduce(no Python argument) |
The command line’s only: lx.fsl.rmsdiff takes no upstream_defects. The variable LARMORX_UPSTREAM_DEFECTS in 0.1.0rc1. |
Examples
The tests run every example below (validation/tests/test_reference.py), each section in a new folder where these inputs are made first: a.mat (the identity as a 4 × 4 text matrix), b.mat (the identity as a 4 × 4 text matrix), boldref.nii.gz (a synthetic head of 40 × 48 × 40 voxels of 4 mm). The command lines run as python -m larmorx.
import larmorx as lx
d = lx.fsl.rmsdiff("a.mat", "b.mat", "boldref.nii.gz")larmorx fsl rmsdiff a.mat b.mat boldref.nii.gzPorts
rmsdiff has two ports: a replica and a clean room.
| Port | Package | Licence | Status | Records |
|---|---|---|---|---|
| replica | larmorx-nc |
FSL Licence: non-commercial use only | experimental | fsl-flirt-replica |
| clean room | larmorx |
Apache-2.0 | experimental | fsl-flirt |
Both ports are complete (specs/flirt.md §15.3). Where FSL aborts, they print the same lines and
exit with status 1.
The replica’s record holds 7 cases of rmsdiff: 4 identical to FSL, 3 where both refuse or abort
alike. The clean room’s holds 7: 4 identical to FSL in every byte of text and file, 3 where both
refuse or abort alike.
FSL’s licence allows non-commercial use only, so each of FLIRT’s programs has two ports, a replica and a clean room, in different packages (licensing says what each package holds):
- The replica is translated from FSL’s source. The package
larmorx-ncholds it (crates-nc/), under the FSL Licence’s terms, andlarmorxruns it as a separate program,larmorx-nc fsl <program>, whenlarmorx-ncis installed (pip install larmorx-nc). - The clean room is written from
specs/flirt.mdby an implementer who never read FSL’s source or the replica. It is part oflarmorx, under Apache-2.0 (crates/larmorx-fsl, with its PROVENANCE, section “FLIRT”), and runs on LARMORX’s clean-room registration engine, the head-motion correction’s (lx.mri.hmc).
implementation="auto" runs the replica when larmorx-nc is installed, and the clean room
otherwise. "replica" and "clean-room" choose one ("original", 0.1.0rc1’s spelling of
"clean-room", still works); "clean-room" runs the clean room in this process. On the command
line, --implementation auto|replica|clean-room before the family chooses alike, from the next
release; in 0.1.0rc1 the variable LARMORX_IMPLEMENTATION chooses (original for the clean
room).
Evidence
How each of rmsdiff’s ports was measured against FSL, case by case: its evidence.
More in the repository
The API page docs/api/fsl-flirt.md holds what rmsdiff shares with the page’s other programs: