Skip to content

Commit d363669

Browse files
mseng10dzenanz
authored andcommitted
DOC: Create README.rst for the module
1 parent e771184 commit d363669

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
MultipleImageIterator
2+
==============================
3+
4+
.. image:: https://github.com/KitwareMedical/MultipleImageIterator/workflows/Build,%20test,%20package/badge.svg
5+
6+
Overview
7+
--------
8+
9+
An `ITK <http://itk.org>`_-based implementation of principal components analysis.
10+
11+
For more information, see the `Insight Journal article <http://hdl.handle.net/10380/3455>`_::
12+
13+
Schaerer J.
14+
A MultipleImageIterator for iterating over multiple images simultaneously
15+
The Insight Journal. December, 2014.
16+
http://hdl.handle.net/10380/3455
17+
http://www.insight-journal.org/browse/publication/915
18+
19+
Installation
20+
------------
21+
22+
Since ITK 4.11.0, this module is available in the ITK source tree as a Remote
23+
module. To enable it, set::
24+
25+
Module_MultipleImageIterator:BOOL=ON
26+
27+
in ITK's CMake build configuration.
28+
29+
License
30+
-------
31+
32+
This software is distributed under the Apache 2.0 license. Please see
33+
the *LICENSE* file for details.

0 commit comments

Comments
 (0)