enh: add doctest to asaffine()

Author: oesteban

nitransforms/linear.py

@@ -13,6 +13,7 @@
 from scipy import ndimage as ndi
 
 from nibabel.loadsave import load as _nbload
+from nibabel.affines import from_matvec
 
 from nitransforms.base import (
     ImageGrid,
@@ -218,6 +219,24 @@ def from_filename(cls, filename, fmt=None, reference=None, moving=None):
             f"Could not open <{filename}> (formats tried: {', '.join(fmtlist)})."
         )
 
+    @classmethod
+    def from_matvec(cls, mat=None, vec=None, reference=None):
+        """
+        Create an affine from a matrix and translation pair.
+
+        Example
+        -------
+        >>> Affine.from_matvec(vec=(4, 0, 0))  # doctest: +NORMALIZE_WHITESPACE
+        array([[1., 0., 0., 4.],
+               [0., 1., 0., 0.],
+               [0., 0., 1., 0.],
+               [0., 0., 0., 1.]])
+
+        """
+        mat = mat if mat is not None else np.eye(3)
+        vec = vec if vec is not None else np.zeros((3,))
+        return cls(from_matvec(mat, vector=vec), reference=reference)
+
     def __repr__(self):
         """
         Change representation to the internal matrix.

nitransforms/manip.py

@@ -144,6 +144,18 @@ def asaffine(self, indices=None):
         """
         Combine a succession of linear transforms into one.
 
+        Example
+        ------
+        >>> chain = TransformChain(transforms=[
+        ...     Affine.from_matvec(vec=(2, -10, 3)),
+        ...     Affine.from_matvec(vec=(-2, 10, -3)),
+        ... ])
+        >>> chain.asaffine()
+        array([[1., 0., 0., 0.],
+               [0., 1., 0., 0.],
+               [0., 0., 1., 0.],
+               [0., 0., 0., 1.]])
+
         Parameters
         ----------
         indices : :obj:`numpy.array_like`