CHANGELOG.rst 23.4 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
2.4.0 (Under development)
-------------------------


Paul McCarthy's avatar
Paul McCarthy committed
9
10
11
12
13
14
15
16
Added
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
17
18
19
20
21
22
23
24
Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
25
26
27
28
29
30
31
32
33
34
35
2.3.1 (Friday July 5th 2019)
----------------------------


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
36
37
2.3.0 (Tuesday June 25th 2019)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
38
39
40
41
42
43


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
44
45
46
47
48
* 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.
Paul McCarthy's avatar
Paul McCarthy committed
49
50
* New :attr:`.Image.nvals` property, for use with ``RGB24``/``RGBA32``
  images.
Paul McCarthy's avatar
Paul McCarthy committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
* 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.
Paul McCarthy's avatar
Paul McCarthy committed
65
* Fixed a bug in the :meth:`.GitfitMesh.loadVertices` method.
Paul McCarthy's avatar
Paul McCarthy committed
66
67
* Fixed a bug in the :meth:`.Mesh.addVertices` method where the wrong face
  normals could be used for newly added vertex sets.
Paul McCarthy's avatar
Paul McCarthy committed
68
69


Paul McCarthy's avatar
Paul McCarthy committed
70
71
2.2.0 (Wednesday May 8th 2019)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
72
73


Paul McCarthy's avatar
Paul McCarthy committed
74
75
76
77
78
79
80
81
82
83
84
85
86
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.


Paul McCarthy's avatar
Paul McCarthy committed
87
88
89
90
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
91
92
93
94
95
96
97
* 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.


Paul McCarthy's avatar
Paul McCarthy committed
98
99
100
101
Fixed
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
102
* Minor fixes to some :mod:`.filetree.filetree` tree definitions.
Paul McCarthy's avatar
Paul McCarthy committed
103
104


Paul McCarthy's avatar
Paul McCarthy committed
105
106
107
108
109
110
Deprecated
^^^^^^^^^^


* The :meth:`.Image.resample` method has been deprecated in favour of the
  :func:`.resample.resample` function.
Paul McCarthy's avatar
Paul McCarthy committed
111
112


Paul McCarthy's avatar
Paul McCarthy committed
113
114
2.1.0 (Saturday April 13th 2019)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
115
116
117
118
119
120
121
122


Added
^^^^^


* New tensor conversion routines in the :mod:`.dtifit` module (Michiel
  Cottaar).
Paul McCarthy's avatar
Paul McCarthy committed
123
124
* New :func:`.makeWriteable` function which ensures that a ``numpy.array`` is
  writeable, and creates a copy if necessary
Paul McCarthy's avatar
Paul McCarthy committed
125
126


Paul McCarthy's avatar
Paul McCarthy committed
127
128
129
130
131
Changed
^^^^^^^


* The :class:`.GiftiMesh` class no longer creates copies of the mesh
Paul McCarthy's avatar
Paul McCarthy committed
132
133
  vertex/index arrays. This means that, these arrays will be flagged as
  read-only.
Paul McCarthy's avatar
Paul McCarthy committed
134
135
136
* 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.
Paul McCarthy's avatar
Paul McCarthy committed
137
138


Paul McCarthy's avatar
Paul McCarthy committed
139
140
141
142
143
144
145
146
147
Fixed
^^^^^


* The :class:`.FeatDesign` class now handles "compressed" voxelwise EV files,
  such as those generated by `PNM
  <https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/PNM>`_.


Paul McCarthy's avatar
Paul McCarthy committed
148
149
150
151
152
153
154
155
156
157
158
159
2.0.1 (Monday April 1st 2019)
-----------------------------


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
160
161
2.0.0 (Friday March 20th 2019)
------------------------------
162
163


164
165
166
Added
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
167
* New :mod:`fsl.utils.filetree` package for defining and working with
Paul McCarthy's avatar
Paul McCarthy committed
168
  file/directory templates (Michiel Cottaar).
Paul McCarthy's avatar
Paul McCarthy committed
169
* Simple built-in :mod:`.deprecated` decorator.
Paul McCarthy's avatar
Paul McCarthy committed
170
* New :mod:`fsl.data.utils` module, which currently contains one function
171
  :func:`.guessType`, which guesses the data type of a file/directory path.
172
* New :func:`.commonBase` function for finding the common prefix of a set of
Paul McCarthy's avatar
Paul McCarthy committed
173
  file/directory paths.
174
175


176
177
178
Changed
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
179

180
* Removed support for Python 2.7 and 3.4.
181
182
183
* Minimum required version of ``nibabel`` is now 2.3.
* The :class:`.Image` class now fully delegates to ``nibabel`` for managing
  file handles.
Paul McCarthy's avatar
Paul McCarthy committed
184
* The :class:`.GiftiMesh` class can now load surface files which contain
Paul McCarthy's avatar
Paul McCarthy committed
185
186
187
  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.
Paul McCarthy's avatar
Paul McCarthy committed
188
189


Paul McCarthy's avatar
Paul McCarthy committed
190
191
192
193
194
195
Removed
^^^^^^^

* Many deprecated items removed.


Paul McCarthy's avatar
Paul McCarthy committed
196
197
198
199
200
201
202
203
Deprecated
^^^^^^^^^^


* Deprecated the :func:`.loadIndexedImageFile`  function, and the ``indexed``
  flag to the :class:`.Image` constructor.


Paul McCarthy's avatar
Paul McCarthy committed
204
205
206
207
1.13.3 (Friday February 8th 2019)
---------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
208
209
210
Fixed
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
211

212
* Fixed an issue with the :func:`.dicom.loadSeries` using memory-mapping for
Paul McCarthy's avatar
Paul McCarthy committed
213
  image files that would subsequently be deleted.
Paul McCarthy's avatar
Paul McCarthy committed
214
* Fixed an issue in the :class:`.GiftiMesh` class, where
Paul McCarthy's avatar
Paul McCarthy committed
215
216
217
  ``numpy``/``nibabel`` was returning read-only index arrays.


Paul McCarthy's avatar
Paul McCarthy committed
218
219
220
221
222
223
224
225
1.13.2 (Friday November 30th 2018)
----------------------------------


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
226
227
* The :meth:`.Image.resample` method now supports images with more than three
  dimensions.
Michiel Cottaar's avatar
Michiel Cottaar committed
228
229
230
231
* The :func:`fsl.utils.fslsub.submit` now returns the job-id as a string
  rather than a one-element tuple. It now also accepts a nested sequence
  of job ids rather than just a flat sequence. This will also changes the
  output from the function wrappers in :mod:`fsl.wrappers` if submitted.
232
233


Paul McCarthy's avatar
Paul McCarthy committed
234
235
Fixed
^^^^^
Paul McCarthy's avatar
Paul McCarthy committed
236

Paul McCarthy's avatar
Paul McCarthy committed
237
238
239
240
241
242

* Fix to the :class:`.ImageWrapper` regarding complex data types.


1.13.1 (Friday November 23rd 2018)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
243
244


Paul McCarthy's avatar
Paul McCarthy committed
245
246
247
248
Fixed
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
249
* Added a missing ``image`` attribute in the :class:`.VoxelwiseConfoundEV`
Paul McCarthy's avatar
Paul McCarthy committed
250
  class.
Paul McCarthy's avatar
Paul McCarthy committed
251
252
253
* Make sure that FEAT ``Cluster`` objects (created by the
  :func:`.loadClusterResults` function) contain ``p`` and ``logp`` attributes,
  even when cluster thresholding was not used.
Paul McCarthy's avatar
Paul McCarthy committed
254
255


Paul McCarthy's avatar
Paul McCarthy committed
256
257
1.13.0 (Thursday 22nd November 2018)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
258

Paul McCarthy's avatar
Paul McCarthy committed
259
260
261
262

Added
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
263
* New wrapper functions for :func:`.fsl_anat`, :func:`.applytopup` (Martin
Paul McCarthy's avatar
Paul McCarthy committed
264
  Craig).
Paul McCarthy's avatar
Paul McCarthy committed
265
* New :func:`.fileOrText` decorator for use in wrapper functions (Martin
Paul McCarthy's avatar
Paul McCarthy committed
266
267
268
269
  Craig).


Changed
Paul McCarthy's avatar
Paul McCarthy committed
270
271
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
272
273
* Various minor changes and enhancements to the FSL function :mod:`.wrappers`
  interfaces (Martin Craig).
Paul McCarthy's avatar
Paul McCarthy committed
274
275
276
277
278
279
280


Fixed
^^^^^

* The ``immv`` and ``imcp`` scripts now accept incorrect file extensions on
  input arguments.
Paul McCarthy's avatar
Paul McCarthy committed
281
282


Paul McCarthy's avatar
Paul McCarthy committed
283
284
1.12.0 (Sunday October 21st 2018)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302


Changed
^^^^^^^


* The ``extract_noise`` script has been renamed to :mod:`.fsl_ents`.
* Increased the minimum required version of ``dcm2niix`` in the
  :mod:`fsl.data.dicom` module.


Deprecated
^^^^^^^^^^


* The ``extract_noise`` script.


Paul McCarthy's avatar
Paul McCarthy committed
303
304
305
306
307
308
309
310
311
312
313
1.11.1 (Friday September 14th 2018
----------------------------------


Fixed
^^^^^


* Fixed a Python 2 incompatibility in the :mod:`.settings` module.


Paul McCarthy's avatar
Paul McCarthy committed
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
1.11.0 (Thursday September 13th 2018)
-------------------------------------


Added
^^^^^


* A couple of new convenience functions to the :mod:`.settings` module.


Changed
^^^^^^^


* Development (test and documentation dependencies) are no longer listed
  in ``setup.py`` - they now need to be installed manually.
* Removed conda build infrastructure.


Paul McCarthy's avatar
Paul McCarthy committed
334
335
336
337
338
339
340
341
342
343
344
345
346
347
1.10.3 (Sunday September 9th 2018)
----------------------------------


Added
^^^^^


* The :func:`.parseVersionString` function accepts (and ignores) `local
  version identifer
  <https://www.python.org/dev/peps/pep-0440/#local-version-identifiers>`_
  strings.


Paul McCarthy's avatar
Paul McCarthy committed
348
349
350
351
352
353
354
355
356
357
358
359
1.10.2 (Friday September 7th 2018)
----------------------------------


Fixed
^^^^^


* The :meth:`.Image.save` method was not handling memory-mapped images
  correctly.


360
361
362
363
364
365
366
367
368
369
370
371
372
373
1.10.1 (Friday August 3rd 2018)
-------------------------------


Changed
^^^^^^^


* Minor adjustmenets to improve Windows compatibility.


Fixed
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
374
* The :mod:`.FEATImage.getCOPE` method was returning PE images.
375
376


377
378
1.10.0 (Wednesday July 18th 2018)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
379
380
381
382
383
384
385
386
387
388


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.
389
* The :func:`.fileOrImage` and :func:`.fileOrArray` decorators now support
Paul McCarthy's avatar
Paul McCarthy committed
390
  loading of files which are specified with an output basename.
391
* New :mod:`.fast` wrapper function for the FSL FAST tool.
Paul McCarthy's avatar
Paul McCarthy committed
392
393
394
395
396
397
398
399
400
401
402


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
403
404
1.9.0 (Monday June 4th 2018)
----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438


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`.


Paul McCarthy's avatar
Paul McCarthy committed
439
440
441
442
443
444
445
446
447
448
449
450
1.8.1 (Friday May 11th 2018)
----------------------------


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
451
452
1.8.0 (Thursday May 3rd 2018)
-----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
453
454
455
456
457
458
459
460
461
462


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.
Paul McCarthy's avatar
Paul McCarthy committed
463
* New :mod:`fsl.utils.fslsub` module, containing a :func:`.fslsub.submit`
Paul McCarthy's avatar
Paul McCarthy committed
464
  function which submits a cluster job via ``fsl_sub``.
Paul McCarthy's avatar
Paul McCarthy committed
465
466
* Assertions (in the :mod:`.assertions` module) can be disabled with the
  new :func:`.assertions.disabled` context manager.
Paul McCarthy's avatar
Paul McCarthy committed
467
468
* New :mod:`fsl.utils.parse_data` module containing various neuroimaging
  data constructors for use with ``argparse``.
Paul McCarthy's avatar
Paul McCarthy committed
469
470
* The :func:`.memoize.skipUnchanged` decorator has an ``invalidate`` function
  which allows its cache to be cleared.
Paul McCarthy's avatar
Paul McCarthy committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487


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`).


488
489
1.7.2 (Monday March 19th 2018)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
490
491
492
493
494
495


Added
^^^^^


496
497
* Added the :meth:`.MGHImage.voxToSurfMat` and related properties, giving
  access to the voxel-to-surface affine for an MGH image.
Paul McCarthy's avatar
Paul McCarthy committed
498
499


Paul McCarthy's avatar
Paul McCarthy committed
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
1.7.1 (Monday March 12th 2018)
------------------------------



Changed
^^^^^^^


* Adjusted :func:`.parseVersionString` so it accepts ``.dev*`` suffixes.


Fixed
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
516
* Removed deprecated use of :func:`.imagewrapper.canonicalShape`.
Paul McCarthy's avatar
Paul McCarthy committed
517
518


Paul McCarthy's avatar
Paul McCarthy committed
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
1.7.0 (Tuesday March 6th 2018)
------------------------------


Added
^^^^^


* The :mod:`fsl.utils.assertions` module contains a range of functions
  which can be used to assert that some condition is met.
* The :mod:`fsl.utils.ensure` module contains a range of functions (currently
  just one) which can be used to ensure that some condiution is met.


Changed
^^^^^^^


* The :mod:`.settings` module now saves its files in a format that is
  compatible with Python 2 and 3.
* The :func:`.tempdir` function now accepts a ``root`` argument, which
  specifies the location in which the temporary directory should be created.
* An image's data source can now be set via  :meth:`.Image.__init__`.
* :meth:`.MGHImage` objects now have a :meth:`.MGHImage.save` method.
* Adjustments to the ``conda`` package build and deployment process.
* The :func:`.ImageWrapper.canonicalShape` function has been moved
Paul McCarthy's avatar
Paul McCarthy committed
545
  to the :mod:`.data.image` class.
Paul McCarthy's avatar
Paul McCarthy committed
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
* The :func:`.ImageWrapper.naninfrange` function has been moved
  into its own :mod:`.naninfrange` module.


Fixed
^^^^^


* Fixed a bug in the :class:`.MutexFactory` class.


Deprecated
^^^^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
561
* :func:`.ImageWrapper.canonicalShape` (moved to the :mod:`.data.image` module)
Paul McCarthy's avatar
Paul McCarthy committed
562
563
564
565
* :func:`.ImageWrapper.naninfrange` function (moved to the :mod:`.naninfrange`
  module)


Paul McCarthy's avatar
Paul McCarthy committed
566
567
568
569
570
571
572
1.6.8 (Monday February 12th 2018)
---------------------------------


* The `atlasq`, `immv`, `imcp` and `imglob` scripts suppress some warnings.


Paul McCarthy's avatar
Paul McCarthy committed
573
574
575
576
577
1.6.7 (Friday February 9th 2018)
--------------------------------


* More further adjustments to the ``conda`` package build.
Paul McCarthy's avatar
Paul McCarthy committed
578
* Adjustments to pypi source distribution - the ``requirements-extra.txt`` file
Paul McCarthy's avatar
Paul McCarthy committed
579
580
581
  was not being included.


Paul McCarthy's avatar
Paul McCarthy committed
582
583
584
585
586
587
588
1.6.6 (Thursday February 8th 2018)
----------------------------------


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


Paul McCarthy's avatar
Paul McCarthy committed
589
590
591
592
593
594
595
1.6.5 (Tuesday February 6th 2018)
---------------------------------


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


Paul McCarthy's avatar
Paul McCarthy committed
596
597
598
599
600
601
602
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
603
604
1.6.3 (Friday February 2nd 2018)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
605
606
607


* Minor enhancements to the :class:`.WeakFunctionRef` class.
Paul McCarthy's avatar
Paul McCarthy committed
608
609
610
* 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
611
612


Paul McCarthy's avatar
Paul McCarthy committed
613
614
615
616
617
618
619
620
621
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
622
623
624
625
626
627
628
629
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
630
631
1.6.0 (Friday January 26th 2018)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
632
633


Paul McCarthy's avatar
Paul McCarthy committed
634
635
636
637
638
639
640
641
642
643
644
645
646
* 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
647
648
* 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
649
650
651
* 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
652
653
654
655
656
* 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
657
* Optional dependencies ``wxpython``, ``indexed_gzip``, ``trimesh``, and
Paul McCarthy's avatar
Paul McCarthy committed
658
659
  ``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
660
661


Paul McCarthy's avatar
Paul McCarthy committed
662
663
664
665
666
667
668
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
669
1.5.3 (Tuesday January 9th 2018)
670
671
672
673
674
675
676
--------------------------------


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


Paul McCarthy's avatar
Paul McCarthy committed
677
678
679
680
681
682
683
1.5.2 (Tuesday January 2nd 2018)
--------------------------------


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


Paul McCarthy's avatar
Paul McCarthy committed
684
685
686
687
688
689
690
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
691
692
1.5.0 (Wednesday December 13th 2017)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
693
694
695
696
697
698


* 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
699
700
701
* 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
702
703


Paul McCarthy's avatar
Paul McCarthy committed
704
705
1.4.2 (Tuesday December 5th 2017)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
706
707
708
709
710


* 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
711
* Some small bugfixes to the :mod:`.atlasq` and :mod:`.atlases` moduless.
Paul McCarthy's avatar
Paul McCarthy committed
712
713
714


1.4.1 (Thursday November 9th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
715
716
717
718
719
720
----------------------------------


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


Paul McCarthy's avatar
Paul McCarthy committed
721
1.4.0 (Thursday November 9th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
722
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
723

Paul McCarthy's avatar
Paul McCarthy committed
724

Paul McCarthy's avatar
Paul McCarthy committed
725
726
* 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
727
728
729
* 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
730
731
732
733
734
735
736
737
738
739
740
741
742
743
* 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
744
1.3.1 (Wednesday October 25th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
745
746
747
748
749
750
751
-----------------------------------


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


Paul McCarthy's avatar
Paul McCarthy committed
752
1.3.0 (Wednesday October 25th 2017)
Paul McCarthy's avatar
Paul McCarthy committed
753
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
754
755
756
757


* :class:`.Atlas` classes can now pass ``kwargs`` through to the
  :class:`.Image` constructor.
Paul McCarthy's avatar
Paul McCarthy committed
758
759
760
* :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
761
* :class:`.Cache` now implements ``__getitem__`` and ``__setitem__``
Paul McCarthy's avatar
Paul McCarthy committed
762
763
* 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
764
765
* :func:`.platform.isWidgetAlive` is deprecated in favour of an equivalent
  function in the ``fsleyes-widgets`` library.
Paul McCarthy's avatar
Paul McCarthy committed
766
767
* ``scipy`` is now explicitly listed as a requirement (this should have been
  done in 1.2.1).
Paul McCarthy's avatar
Paul McCarthy committed
768
769
770
771
772
773
774



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


Paul McCarthy's avatar
Paul McCarthy committed
775
776
* 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
777
778
779
780
781


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

Paul McCarthy's avatar
Paul McCarthy committed
782

Paul McCarthy's avatar
Paul McCarthy committed
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
* 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
799
  favour of new :meth:`.Nifti.voxToScaledVoxMat` and
Paul McCarthy's avatar
Paul McCarthy committed
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
  :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
821
822
823
824
825
826
827
828
829
830
831
832

 - :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
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
* 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