Skip to content

Commit

Permalink
DOC: Add work in progress note
Browse files Browse the repository at this point in the history
  • Loading branch information
thewtex committed Sep 11, 2019
1 parent 6ed7dd7 commit ea53c8b
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,27 +24,7 @@ used to solve (medical) image registration problems. The modular design of
elastix allows the user to quickly configure, test, and compare different
registration methods for a specific application.

Installation
------------

Install cross-platform binary Python packages with::

pip install itk-elastix

Usage
-----

To register two images, traditionally called the fixed image and the moving
image::

import itk

# The fixed and moving image can be an itk.Image or a numpy.ndarray
fixed_image = itk.imread('path/to/fixed_image.mha')
moving_image = itk.imread('path/to/moving_image.mha')

registered_image = itk.elastix_registration_method(fixed_image, moving_image)

.. note:: This package is a work in progress.

Acknowledgements
----------------
Expand Down

0 comments on commit ea53c8b

Please # to comment.