Skip to content
Snippets Groups Projects
Commit 2de38f86 authored by Paul McCarthy's avatar Paul McCarthy :mountain_bicyclist:
Browse files

DOC: Fixes to docs

parent 1b99d8a7
No related branches found
No related tags found
No related merge requests found
...@@ -13,6 +13,7 @@ following sub-packages: ...@@ -13,6 +13,7 @@ following sub-packages:
fsl.data fsl.data
fsl.utils fsl.utils
fsl.scripts fsl.scripts
fsl.transform
fsl.version fsl.version
fsl.wrappers fsl.wrappers
...@@ -22,4 +23,4 @@ following sub-packages: ...@@ -22,4 +23,4 @@ following sub-packages:
for details. for details.
""" """
__path__ = __import__('pkgutil').extend_path(__path__, __name__) __path__ = __import__('pkgutil').extend_path(__path__, __name__) # noqa
...@@ -224,7 +224,7 @@ class Nifti(notifier.Notifier, meta.Meta): ...@@ -224,7 +224,7 @@ class Nifti(notifier.Notifier, meta.Meta):
=============== ======================================================== =============== ========================================================
``'transform'`` The affine transformation matrix has changed. This topic ``'transform'`` The affine transformation matrix has changed. This topic
will occur when the :meth:`voxToWorldMat` is changed. will occur when the :meth:`voxToWorldMat` is changed.
``'header A header field has changed. This will occur when the ``'header'`` A header field has changed. This will occur when the
:meth:`intent` is changed. :meth:`intent` is changed.
=============== ======================================================== =============== ========================================================
""" # noqa """ # noqa
......
...@@ -139,7 +139,7 @@ class NonLinearTransform(fslimage.Image): ...@@ -139,7 +139,7 @@ class NonLinearTransform(fslimage.Image):
reference space. reference space.
:arg from_: Reference image space that ``coords`` are defined in :arg from_: Reference image space that ``coords`` are defined in
:arg to: Source image space to transform ``coords`` into :arg to: Source image space to transform ``coords`` into
:returns ``coords``, transformed into the source image space :returns: ``coords``, transformed into the source image space
""" """
raise NotImplementedError() raise NotImplementedError()
...@@ -217,7 +217,7 @@ class DisplacementField(NonLinearTransform): ...@@ -217,7 +217,7 @@ class DisplacementField(NonLinearTransform):
reference space. reference space.
:arg from_: Reference image space that ``coords`` are defined in :arg from_: Reference image space that ``coords`` are defined in
:arg to: Source image space to transform ``coords`` into :arg to: Source image space to transform ``coords`` into
:returns ``coords``, transformed into the source image space :returns: ``coords``, transformed into the source image space
""" """
if from_ is None: from_ = self.refSpace if from_ is None: from_ = self.refSpace
...@@ -400,11 +400,11 @@ class CoefficientField(NonLinearTransform): ...@@ -400,11 +400,11 @@ class CoefficientField(NonLinearTransform):
:arg to: Source image space to transform ``coords`` into :arg to: Source image space to transform ``coords`` into
:returns ``coords``, transformed into the source image space
:arg premat: If ``True``, the inverse :meth:`srcToRefMat` is applied :arg premat: If ``True``, the inverse :meth:`srcToRefMat` is applied
to the coordinates after the displacements have been to the coordinates after the displacements have been
addd. addd.
:returns: ``coords``, transformed into the source image space
""" """
df = self.asDisplacementField(premat=premat) df = self.asDisplacementField(premat=premat)
return df.transform(coords, from_, to) return df.transform(coords, from_, to)
...@@ -629,7 +629,7 @@ def coefficientFieldToDisplacementField(field, ...@@ -629,7 +629,7 @@ def coefficientFieldToDisplacementField(field,
:arg field: :class:`CoefficientField` to convert :arg field: :class:`CoefficientField` to convert
:arg dispType: The type of displcaement field - either ``'relative'`` (the :arg dispType: The type of displacement field - either ``'relative'`` (the
default) or ``'absolute'``. default) or ``'absolute'``.
:arg premat: If ``True`` (the default), the :meth:`srcToRefMat` is :arg premat: If ``True`` (the default), the :meth:`srcToRefMat` is
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment