CHANGELOG.rst 11.1 KB
Newer Older
Paul McCarthy's avatar
Paul McCarthy committed
1
2
This document contains the ``fslpy`` release history in reverse chronological
order.
Paul McCarthy's avatar
Paul McCarthy committed
3
4


Paul McCarthy's avatar
Paul McCarthy committed
5
6
7
8
9
10
11
12
13
1.6.7 (Friday February 9th 2018)
--------------------------------


* More further adjustments to the ``conda`` package build.
* Adjustments to pypi source distribution - the `requirements-extra.txt` file
  was not being included.


Paul McCarthy's avatar
Paul McCarthy committed
14
15
16
17
18
19
20
1.6.6 (Thursday February 8th 2018)
----------------------------------


* Further adjustments to the ``conda`` package build.


Paul McCarthy's avatar
Paul McCarthy committed
21
22
23
24
25
26
27
1.6.5 (Tuesday February 6th 2018)
---------------------------------


* Adjustments to the ``conda`` package build.


Paul McCarthy's avatar
Paul McCarthy committed
28
29
30
31
32
33
34
1.6.4 (Monday February 5th 2018)
--------------------------------


* The :mod:`.platform` module emits a warning if it cannot import ``wx``.


Paul McCarthy's avatar
Paul McCarthy committed
35
36
1.6.3 (Friday February 2nd 2018)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
37
38
39


* Minor enhancements to the :class:`.WeakFunctionRef` class.
Paul McCarthy's avatar
Paul McCarthy committed
40
41
42
* Some bugfixes to the :mod:`fsl.utils.imcp` module, with respect to handling
  relative path names, moving file groups (e.g. `.img`/`.hdr` pairs), and
  non-existent directories.
Paul McCarthy's avatar
Paul McCarthy committed
43
44


Paul McCarthy's avatar
Paul McCarthy committed
45
46
47
48
49
50
51
52
53
1.6.2 (Tuesday January 30th 2018)
---------------------------------


* Updates to the ``conda`` installation process.
* A new script is installed when ``fslpy`` is installed via ``pip`` or
  ``conda`` - ``atlasquery``, which emulates the FSL ``atlasquery`` tool.


Paul McCarthy's avatar
Paul McCarthy committed
54
55
56
57
58
59
60
61
1.6.1 (Monday January 29th 2018)
--------------------------------


* Removed ``lxml`` as a dependency - this was necessary in older versions of
  ``trimesh``.


Paul McCarthy's avatar
Paul McCarthy committed
62
63
1.6.0 (Friday January 26th 2018)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
64
65


Paul McCarthy's avatar
Paul McCarthy committed
66
67
68
69
70
71
72
73
74
75
76
77
78
* The new :class:`.Mesh` class is now the base class for all mesh types. It
  has been written to allow multiple sets of vertices to be associated with a
  mesh object (to support e.g. white matter, inflated, spherical models for a
  GIFTI/freeusrfer mesh).
* The new :class:`.VTKMesh` class must now be used for loading VTK model files,
  instead of the old :class:`.TriangleMesh` class.
* The new :class:`.Mesh` class uses the ``trimesh`` library
  (https://github.com/mikedh/trimesh) to perform various geometrical
  operations, accessible via new :meth:`.Mesh.rayIntersection`,
  :meth:`.Mesh.planeIntersection`, :meth:`.Mesh.nearestVertex` methods.
* The :class:`.Nifti` and :class:`.Mesh` classes have new methods allowing
  arbitrary metadata to be stored with the image, as key-value
  pairs. These are provided by a new mixin class, :class:`.Meta`.
Paul McCarthy's avatar
Paul McCarthy committed
79
80
* Freesurer surface files and vertex data can now be loaded via the
  :class:`.FreesurferMesh` class, in the new :mod:`.freesurfer` module.
Paul McCarthy's avatar
Paul McCarthy committed
81
82
83
* Freesurfer ``mgz`` / ``mgh`` image files can now be loaded via the new
  :mod:`.mghimage` module. Internally, these image files are converted to NIFTI
  - the :class:`.MGHImage` class derives from the :class:`.Image` class.
Paul McCarthy's avatar
Paul McCarthy committed
84
85
86
87
88
* Meta-data access methods on the :class:`.DicomImage` class have been
  deprecated, as their functionality is provided by the new :class:`.Meta`
  mixin.
* The :class:`.TriangleMesh` class has been deprecated in favour of the new
  :class:`.Mesh` class.
Paul McCarthy's avatar
Paul McCarthy committed
89
* Optional dependencies ``wxpython``, ``indexed_gzip``, ``trimesh``, and
Paul McCarthy's avatar
Paul McCarthy committed
90
91
  ``rtree`` are now listed separately, so ``fslpy`` can be used without them
  (although relevant functionality will be disabled if they are not present).
Paul McCarthy's avatar
Paul McCarthy committed
92
93


Paul McCarthy's avatar
Paul McCarthy committed
94
95
96
97
98
99
100
1.5.4 (Wednesday January 10th 2018)
-----------------------------------


* Actually included the fix that was supposed to be in version 1.5.3.


Paul McCarthy's avatar
Paul McCarthy committed
101
1.5.3 (Tuesday January 9th 2018)
102
103
104
105
106
107
108
--------------------------------


* Bug fix to :meth:`.ImageWrapper.__expandCoverage` - was not correctly handling
  large images with lots of ``nan`` values.


Paul McCarthy's avatar
Paul McCarthy committed
109
110
111
112
113
114
115
1.5.2 (Tuesday January 2nd 2018)
--------------------------------


* Fixed issue with ``MANIFEST.in`` file.


Paul McCarthy's avatar
Paul McCarthy committed
116
117
118
119
120
121
122
1.5.1 (Thursday December 14th 2017)
-----------------------------------


* Fixed bug in :func:`.dicom.scanDir` function related to data series ordering.


Paul McCarthy's avatar
Paul McCarthy committed
123
124
1.5.0 (Wednesday December 13th 2017)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
125
126
127
128
129
130


* New module :mod:`.dicom`, which provides a thin wrapper on top of Chris
  Rorden's `dcm2niix <https://github.com/rordenlab/dcm2niix>`_.
* New module :mod:`.tempdir`, which has a convenience function for creating
  temporary directories.
Paul McCarthy's avatar
Paul McCarthy committed
131
132
133
* Fixed small issue in :meth:`.Image.dtype` - making sure that it access
  image data via the :class:`.ImageWrapper`, rather than via the `Nifti1Image`
  object.
Paul McCarthy's avatar
Paul McCarthy committed
134
135


Paul McCarthy's avatar
Paul McCarthy committed
136
137
1.4.2 (Tuesday December 5th 2017)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
138
139
140
141
142


* New function :func:`.transform.rmsdev` function, which implements the RMS
  deviation equation for comparing two affine transformations (FMRIB Technical
  Report TR99MJ1, available at https://www.fmrib.ox.ac.uk/datasets/techrep/).
Paul McCarthy's avatar
Paul McCarthy committed
143
* Some small bugfixes to the :mod:`.atlasq` and :mod:`.atlases` moduless.
Paul McCarthy's avatar
Paul McCarthy committed
144
145
146


1.4.1 (Thursday November 9th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
147
148
149
150
151
152
----------------------------------


* Fixed bug in ``setup.py``.


Paul McCarthy's avatar
Paul McCarthy committed
153
1.4.0 (Thursday November 9th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
154
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
155

Paul McCarthy's avatar
Paul McCarthy committed
156

Paul McCarthy's avatar
Paul McCarthy committed
157
158
* The :func:`.uniquePrefix` function now raises a :exc:`~.path.PathError`
  instead of a :exc:`.ValueError`, when an invalid path is provided.
Paul McCarthy's avatar
Paul McCarthy committed
159
160
161
* The :mod:`fsl.utils.async` module is now deprecated, as ``async`` will
  become a reserved word in Python 3.7. It has been renamed to
  ``fsl.utils.idle``, with no other API changes.
Paul McCarthy's avatar
Paul McCarthy committed
162
163
164
165
166
167
168
169
170
171
172
173
174
175
* For image file pairs, the ``hdr`` extension now takes precedence over the
  ``img`` extension, when using the :func:`fsl.data.image.addExt` (and
  related) functions.
* The :func:`fsl.utils.path.addExt` function accepts a new parameter,
  ``unambiguous`` which causes it to allow an ambiguous prefix, and return
  all matching paths.
* New :mod:`~fsl.scripts.atlasq` application, intended to replace the FSL
  ``atlasquery`` tool.
* New :mod:`~fsl.scripts.imglob` application, intended to replace the FSL
  ``imglob`` tool.
* The :meth:`.Image.resample` method explicitly raises a ``ValueError``
  if incompatible shapes are provided.


Paul McCarthy's avatar
Paul McCarthy committed
176
1.3.1 (Wednesday October 25th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
177
178
179
180
181
182
183
-----------------------------------


* Fixed bug in :meth:`.Platform.wxPlatform` causing it to always return
  ``WX_UNKNOWN``.


Paul McCarthy's avatar
Paul McCarthy committed
184
1.3.0 (Wednesday October 25th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
185
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
186
187
188
189


* :class:`.Atlas` classes can now pass ``kwargs`` through to the
  :class:`.Image` constructor.
Paul McCarthy's avatar
Paul McCarthy committed
190
191
192
* :class:`.LabelAtlas` image values no longer need to match the index of the
  label into the :class:`.AtlasDescription` ``labels`` list. This means that
  label atlas XML files may contain non-sequential label values.
Paul McCarthy's avatar
Paul McCarthy committed
193
* :class:`.Cache` now implements ``__getitem__`` and ``__setitem__``
Paul McCarthy's avatar
Paul McCarthy committed
194
195
* The :func:`.image.read_segments` function (monkey-patched into ``nibabel``)
  is deprecated, as it is no longer necessary as of ``nibabel`` 2.2.0.
Paul McCarthy's avatar
Paul McCarthy committed
196
197
* :func:`.platform.isWidgetAlive` is deprecated in favour of an equivalent
  function in the ``fsleyes-widgets`` library.
Paul McCarthy's avatar
Paul McCarthy committed
198
199
* ``scipy`` is now explicitly listed as a requirement (this should have been
  done in 1.2.1).
Paul McCarthy's avatar
Paul McCarthy committed
200
201
202
203
204
205
206



1.2.2 (Saturday October 21st 2017)
----------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
207
208
* The :func:`.image.read_segments` function is only monkey-patched into
  ``nibabel`` 2.1.0, as it breaks when used with 2.2.0.
Paul McCarthy's avatar
Paul McCarthy committed
209
210
211
212
213


1.2.1 (Saturday October 7th 2017)
---------------------------------

Paul McCarthy's avatar
Paul McCarthy committed
214

Paul McCarthy's avatar
Paul McCarthy committed
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
* If an :class:`.Image` is passed an existing ``nibabel`` header object,
  it creates a copy, rather than using the original.
* New :meth:`.Image.resample` method, which resamples the image data to a
  different resolution.
* New :meth:`.LabelAtlas.coordLabel`, :meth:`.LabelAtlas.maskLabel`,
  :meth:`.ProbabilisticAtlas.coordProportions` and
  :meth:`.ProbabilisticAtlas.maskProportions` methods. The ``coord``
  methods perform coordinate queries in voxel or world coordinates,
  and the ``mask`` methods perform mask-based queries.


1.2.0 (Thursday September 21st 2017)
------------------------------------


* :meth:`fsl.data.image.Nifti.voxelsToScaledVoxels` method deprecated in
Paul McCarthy's avatar
Paul McCarthy committed
231
  favour of new :meth:`.Nifti.voxToScaledVoxMat` and
Paul McCarthy's avatar
Paul McCarthy committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
  :meth:`Nifti.scaledVoxToVoxMat` properties.


1.1.0 (Monday September 11th 2017)
----------------------------------


* The :mod:`fsl` package is now a ``pkgutil``-style `namespace package
  <https://packaging.python.org/guides/packaging-namespace-packages/>`_, so it
  can be used for different projects.
* Updates to :class:`fsl.data.image.Nifti` and :class:`fsl.data.image.Image`
  to add support for images with more than 4 dimensions:
  - New ``ndims`` property
  - ``is4DImage`` method deprecated


1.0.5 (Thursday August 10th 2017)
---------------------------------


* New functions and further adjustments in :mod:`fsl.utils.transform` module:
Paul McCarthy's avatar
Paul McCarthy committed
253
254
255
256
257
258
259
260
261
262
263
264

 - :func:`.transform.rotMatToAffine` converts a ``(3, 3)`` rotation matrix
   into a ``(4, 4)`` affine.
 - :func:`.transform.transformNormal` applies an affine transform to one or
   more vectors.
 - :func:`.transform.veclength` calculates the length of a vector
 - :func:`.transform.normalise` normalises a vector
 - :func:`.transform.scaleOffsetXform` adjusted to have more flexibility with
   respect to inputs.
 - :func:`.transform.decompose` can return rotations either as three
   axis-angles, or as a rotation matrix

Paul McCarthy's avatar
Paul McCarthy committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
* Updates to :class:`fsl.data.mesh.TriangleMesh` - ``vertices`` and ``indices``
  are now ``property`` attributes. New lazily generated ``normals`` and
  ``vnormals`` properties (face and vertex normals respectively). Option
  to ``__init__`` to fix the face winding order of a mesh.
* :func:`fsl.utils.memoize.memoize` decorator made into a class rather than a
  function. The new :class:`.Memoize` class has an ``invalidate`` method, which
  clears the cache.


1.0.4 (Friday July 14th 2017)
-----------------------------


* Python 2/3 compatibility fix to :mod:`fsl.utils.callfsl`.
* Fix to :func:`fsl.utils.transform.scaleOffsetXform` - accepts inputs
  that are not lists.
* :func:`fsl.utils.transform.compose` accepts either a sequence of three
  axis angles, or a ``(3, 3)`` rotation matrix.


1.0.3 (Sunday June 11th 2017)
-----------------------------


* Fix to :mod:`fsl.utils.async` which was breaking environments where multiple
  ``wx.App`` instances were being created.


1.0.2 (Thursday June 8th 2017)
------------------------------


* Python 2/3 compatibility fixes
* New :func:`fsl.version.patchVersion` function.


1.0.1 (Sunday 4th June 2017)
----------------------------


* New version number parsing functions in :mod:`fsl.version`.


1.0.0 (Saturday May 27th 2017)
------------------------------


* Removed many GUI-related modules - they have been moved to the
  ``fsleyes-widgets`` project. The following modules have been removed:
  - :mod:`fsl.utils.colourbarbitmap`
  - :mod:`fsl.utils.dialog`
  - :mod:`fsl.utils.imagepanel`
  - :mod:`fsl.utils.layout`
  - :mod:`fsl.utils.platform`
  - :mod:`fsl.utils.runwindow`
  - :mod:`fsl.utils.status`
  - :mod:`fsl.utils.textbitmap`
  - :mod:`fsl.utils.typedict`
  - :mod:`fsl.utils.webpage`
* :mod:`fsl.utils.settings` module rewritten. It no longer uses ``wx``,
  but instead stores plain-text and ``pickle`` files in the user's home
  directory.
* Software GL renderer test in :mod:`fsl.utils.platform` is more lenient
* New :class:`.AtlasLabel` class
* :meth:`.Image.__init__` allows arguments to be passed through to
  ``nibabel.load``.
* New :meth:`.Nifti.strval` method to handle escaped strings in NIFTI headers.
* Python 2/3 compatibility fixes


0.11.0 (Thursday April 20th 2017)
---------------------------------


* First public release as part of FSL 5.0.10