Practical overview
When it fits
Use Voxelmorph when you need a programmable, local workflow for training or applying learning-based image registration models, and can provide data in the documented formats or adapt its data-loading code.
Who it is for
- Researchers working on image registration and alignment.
- Developers building Python workflows for image volumes and deformation modeling.
- Teams adapting learned registration methods to custom image datasets.
Documented uses
- Train an unsupervised image-to-image registration network from an image list.
- Register a moving image to a fixed image or atlas using a trained model.
- Save a warped image and optionally a predicted deformation field.
- Evaluate model results with Dice overlap on segmentation labels.
- Explore atlas construction, annotation warping and deformation-field tutorials.
Requirements & limits
The repository is public and lists an Apache-2.0 license. The README documents installation through PyPI or from a source checkout.
- The README calls the TensorFlow version stable and directs users to the
dev-tensorflowbranch; it warns that PyTorch interfaces may change during active development. - Training examples accept NIfTI, MGZ and NPZ data; NPZ files use a
volfield and may includeseg. - Example training assumes consistent image shapes, although a customized data generator can handle variation.
- Registration requires a trained model plus moving and fixed image inputs; the library is not presented as a hosted processing service.
- The repository includes tutorials for deformable and affine SynthMorph demonstrations, atlas construction, annotation warping and other deformation workflows.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Train and apply a TensorFlow registration model
Train an example image-registration network from a file list, then use its model file to warp a moving image toward a fixed image.
Before you start
- A TensorFlow checkout using the stable
dev-tensorflowbranch. - An image-list file and training data in NIfTI, MGZ or NPZ format; NPZ files should include
vol, with optionalseg. Training image shapes are assumed consistent unless the generator is customized. - A trained model file and moving and fixed images for registration.
Steps
Prepare the image list and training data in a supported format.
Run the documented TensorFlow training script with the image-list path, model output directory and GPU option.
Pass the resulting model file, moving image and fixed image to
register.py, specifying the warped-image output path.Add
--save-warpif the predicted deformation field is also needed.
Expected outcome
The training script saves model weights to the specified model directory; the registration script saves a warped image and can also save the deformation field.
Guide limitations
- Training data-loading code may need customization for dataset formats; consistent image shapes are assumed unless handled by a custom generator.
- The example commands use the TensorFlow scripts and a GPU option; the README warns that PyTorch interfaces may change.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 10 October 2026
- Original website title
- voxelmorph/voxelmorph · Official homepage title · retained in its source language

