CHANGELOG.rst

This document contains the fslpy release history in reverse chronological order.

1.10.1 (Friday August 3rd 2018)

Changed

• Minor adjustmenets to improve Windows compatibility.

Fixed

• The .mod:.FEATImage.getCOPE method was returning PE images.

1.10.0 (Wednesday July 18th 2018)

Added

• A new script, :mod:`.extract_noise`, which can be used to extract ICA component time courses from a MELODIC ICA analysis.
• New :func:`.path.allFiles` function which returns all files underneath a directory.
• The :func:`.fileOrImage` and :func:`.fileOrArray` decorators now support loading of files which are specified with an output basename.
• New :mod:`.fast` wrapper function for the FSL FAST tool.

Changed

• When using the :func:`.run.run` function, the command output/error streams are now forwarded immediately.
• Removed dependency on pytest-runner.

1.9.0 (Monday June 4th 2018)

Added

• New :meth:`.Image.data` property method, for easy access to image data as a numpy array.
• New log option to the :func:`.run.run` function, allowing more fine-grained control over sub-process output streams.
• New :meth:`.Platform.fsldevdir` property, allowing the $FSLDEVDIR environment variable to be queried/changed.

Changed

• :meth:`.Image.ndims` has been renamed to :meth:`.Image.ndim`, to align more closely with numpy naming conventions.
• The err and ret parameters to the :func:`.run.run` function have been renamed to stderr and exitcode respectively.
• The :func:`.runfsl` function will give priority to the $FSLDEVDIR environment variable if it is set.

Deprecated

• :meth:`.Image.ndims`.
• The err and ret parameters to :func:`.run.run`.

1.8.1 (Friday May 11th 2018)

Changed

• The :func:`.fileOrImage` decorator function now accepts :class:`.Image` objects as well as nibabel image objects.

1.8.0 (Thursday May 3rd 2018)

Added

• New :mod:`.wrappers` package, containing wrapper functions for a range of FSL tools.
• New :mod:`fsl.utils.run` module, to replace the :mod:`fsl.utils.callfsl` module.
• New :mod:`fsl.utils.fslsub` module, containing a :func:`.fslsub.submit` function which submits a cluster job via fsl_sub.
• Assertions (in the :mod:`.assertions` module) can be disabled with the new :func:`.assertions.disabled` context manager.
• New :mod:`fsl.utils.parse_data` module containing various neuroimaging data constructors for use with argparse.
• The :func:`.memoize.skipUnchanged` decorator has an invalidate function which allows its cache to be cleared.

Changed

• The :func:`.tempdir` function has an option to not change to the newly created directory.

Deprecated

• The :mod:`fsl.utils.callfsl` module (replaced with :mod:`fsl.utils.run`).

1.7.2 (Monday March 19th 2018)

Added

• Added the :meth:`.MGHImage.voxToSurfMat` and related properties, giving access to the voxel-to-surface affine for an MGH image.

1.7.1 (Monday March 12th 2018)