From 6fb27740c2404f09714e59843089c2fcd6ca1cfc Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Thu, 6 Apr 2017 13:25:00 +0100
Subject: [PATCH] Doc fixes
---
doc/fsl.utils.weakfuncref.rst | 9 +++++++++
fsl/data/mesh.py | 2 +-
fsl/utils/transform.py | 16 ++++++++--------
3 files changed, 18 insertions(+), 9 deletions(-)
create mode 100644 doc/fsl.utils.weakfuncref.rst
diff --git a/doc/fsl.utils.weakfuncref.rst b/doc/fsl.utils.weakfuncref.rst
new file mode 100644
index 000000000..1f2423e04
--- /dev/null
+++ b/doc/fsl.utils.weakfuncref.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+fsl.utils.weakfuncref module
+============================
+
+.. automodule:: fsl.utils.weakfuncref
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/fsl/data/mesh.py b/fsl/data/mesh.py
index 20c728c49..edd16c3d7 100644
--- a/fsl/data/mesh.py
+++ b/fsl/data/mesh.py
@@ -48,7 +48,7 @@ class TriangleMesh(object):
``dataSource`` Full path to the mesh file (or ``None`` if there is
no file associated with this mesh).
- ``vertices`` A :math:`N\times 3` ``numpy `` array containing
+ ``vertices`` A :math:`N\times 3` ``numpy`` array containing
the vertices.
``indices`` A :meth:`M\times 3` ``numpy`` array containing
diff --git a/fsl/utils/transform.py b/fsl/utils/transform.py
index 36af95c95..459fae425 100644
--- a/fsl/utils/transform.py
+++ b/fsl/utils/transform.py
@@ -14,7 +14,7 @@ spaces. The following functions are provided:
scaleOffsetXform
invert
concat
- compse
+ compose
decompose
rotMatToAxisAngles
axisAnglesToRotMat
@@ -417,18 +417,18 @@ def flirtMatrixToSform(flirtMat, srcImage, refImage):
def sformToFlirtMatrix(srcImage, refImage, srcXform=None):
- """Under the assumption that the given ``srcImage`` and ``refImage``
- share a common world coordinate system (defined by their
- :attr:`voxToWorldMat` attributes), this function will calculate and
+ """Under the assumption that the given ``srcImage`` and ``refImage`` share a
+ common world coordinate system (defined by their
+ :attr:`.Nifti.voxToWorldMat` attributes), this function will calculate and
return a transformation matrix from the ``srcImage`` scaled voxel
- coordinate system to the ``refImage`` scaled voxel coordinate system,
- that can be saved to disk and used with FLIRT, to resample the source
- image to the reference image.
+ coordinate system to the ``refImage`` scaled voxel coordinate system, that
+ can be saved to disk and used with FLIRT, to resample the source image to
+ the reference image.
:arg srcImage: Source :class:`.Image`
:arg refImage: Reference :class:`.Image`
:arg srcXform: Optionally used in place of the ``scrImage``
- :attr:`.voxToWorldMat`
+ :attr:`.Nifti.voxToWorldMat`
"""
srcScaledVoxelsToVoxelsMat = invert(srcImage.voxelsToScaledVoxels())
--
GitLab