CHANGELOG.rst

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

2.4.0 (Under development)

Added

• New :mod:`.image.roi` module, for exracting an ROI of an image, or expanding its field-of-view.

Changed

• The :mod:`.resample_image` script has been updated to support resampling of images with more than 3 dimensions.

2.3.1 (Friday July 5th 2019)

Fixed

• The :class:`.Bitmap` class now supports greyscale images and palette images.

2.3.0 (Tuesday June 25th 2019)

Added

• New :class:`.Bitmap` class, for loading bitmap images. The :meth:`.Bitmap.asImage` method can be used to convert a Bitmap into an :class:`.Image`.
• The :class:`.Image` class now has support for the RGB24 and RGBA32 NIfTI data types.
• New :attr:`.Image.nvals` property, for use with RGB24/RGBA32 images.
• New :meth:`.LabelAtlas.get` and :meth:`ProbabilisticAtlas.get` methods, which return an :class:`.Image` for a specific region.
• The :meth:`.AtlasDescription.find` method also now a name parameter, allowing labels to be looked up by name.
• New :meth:`.FileTree.defines` and :meth:`.FileTree.on_disk` methods, to replace the :func:`.FileTree.exists` method.

Fixed

• The :func:`.makeWriteable` function will always create a copy of an array if its base is a bytes object.
• Fixed a bug in the :meth:`.GitfitMesh.loadVertices` method.
• Fixed a bug in the :meth:`.Mesh.addVertices` method where the wrong face normals could be used for newly added vertex sets.

2.2.0 (Wednesday May 8th 2019)

Added

• New :mod:`.resample_image` script.
• New :mod:`.resample` module (replacing the :func:`.Image.resample` method), containing functions to resample an :class:`.Image`.
• New :func:`.resample.resampleToPixdim` and :func:`.resample.resampleToReference` functions, convenience wrappers around :func:`.resample.resample`.
• New :func:`.idle.block` function.

Changed

• The :func:`.resample` function (formerly :meth:`.Image.resample`) now accepts origin and matrix parameters, which can be used to adjust the alignment of the voxel grids of the input and output images.
• The :func:`.transform.decompose` function now accepts both (3, 3) and (4, 4) matrices.

Fixed

• Minor fixes to some :mod:`.filetree.filetree` tree definitions.

Deprecated

• The :meth:`.Image.resample` method has been deprecated in favour of the :func:`.resample.resample` function.

2.1.0 (Saturday April 13th 2019)

Added

• New tensor conversion routines in the :mod:`.dtifit` module (Michiel Cottaar).
• New :func:`.makeWriteable` function which ensures that a numpy.array is writeable, and creates a copy if necessary

Changed

• The :class:`.GiftiMesh` class no longer creates copies of the mesh vertex/index arrays. This means that, these arrays will be flagged as read-only.
• The :class:`.Mesh` class handles vertex data sets requiring different triangle unwinding orders, at the cost of potentially having to store two copies of the mesh indices.

Fixed

• The :class:`.FeatDesign` class now handles "compressed" voxelwise EV files, such as those generated by PNM.

2.0.1 (Monday April 1st 2019)

Fixed

• Fixed a bug with the :func:`.gifti.relatedFiles` function returning duplicate files.

2.0.0 (Friday March 20th 2019)

Added

• New :mod:`fsl.utils.filetree` package for defining and working with file/directory templates (Michiel Cottaar).
• Simple built-in :mod:`.deprecated` decorator.
• New :mod:`fsl.data.utils` module, which currently contains one function :func:`.guessType`, which guesses the data type of a file/directory path.
• New :func:`.commonBase` function for finding the common prefix of a set of file/directory paths.

Changed

• Removed support for Python 2.7 and 3.4.
• Minimum required version of nibabel is now 2.3.
• The :class:`.Image` class now fully delegates to nibabel for managing file handles.
• The :class:`.GiftiMesh` class can now load surface files which contain vertex data, and will accept surface files which end in .gii, rather than requiring files which end in .surf.gii.
• The name property of :class:`.Mesh` instances can now be updated.

Removed