enh: add @effigies' example

nipy · Jul 19, 2022 · 66bd6b2 · 66bd6b2
1 parent 533a03d
commit 66bd6b2
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/nitransforms/manip.py b/nitransforms/manip.py
@@ -156,6 +156,16 @@ def asaffine(self, indices=None):
                [0., 0., 1., 0.],
                [0., 0., 0., 1.]])
 
+        >>> chain = TransformChain(transforms=[
+        ...     Affine.from_matvec(vec=(1, 2, 3)),
+        ...     Affine.from_matvec(mat=[[0, 1, 0], [0, 0, 1], [1, 0, 0]]),
+        ... ])
+        >>> chain.asaffine()
+        array([[0., 1., 0., 2.],
+               [0., 0., 1., 3.],
+               [1., 0., 0., 1.],
+               [0., 0., 0., 1.]])
+
         Parameters
         ----------
         indices : :obj:`numpy.array_like`