CHANGELOG.rst 43.2 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

Paul McCarthy's avatar
Paul McCarthy committed
4

Paul McCarthy's avatar
Paul McCarthy committed
5
6
7
8
9
10
11
12
13
14
15
16
3.8.0 (Under development)
-------------------------


Changed
^^^^^^^


* BIDS and ``dcm2niix`` ``.json`` sidecar files with control characters
  are now accepted.


Paul McCarthy's avatar
Paul McCarthy committed
17
18
3.7.0 (Friday 20th August 2021)
-------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
19
20
21
22
23
24
25
26
27
28
29
30
31


Added
^^^^^


* New :mod:`fsl.wrappers.fsl_sub` wrapper function for the ``fsl_sub``
  command.


Changed
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
32
33
34
35

* Performance of the :mod:`.imglob`, :mod:`.imln`, :mod:`imtest`, :mod:`.imrm`
  and :mod:`.remove_ext` scripts has been improved, by re-organising them to
  avoid unnecessary and expensive imports such as ``numpy``.
Paul McCarthy's avatar
Paul McCarthy committed
36
37
38
39
40
41
42
* The default behaviour of the :func:`fsl.utils.run.run` function (and hence
  that of all :mod:`fsl.wrappers` functions) has been changed so that the
  standard output and error of the called command is now forwarded to the
  calling Python process, in addition to being returned from ``run`` as
  strings. In other words, the default behaviour of ``run('cmd')``, is now
  equivalent to ``run('cmd', log={"tee":True})``. The previous default
  behaviour can be achieved with ``run('cmd', log={"tee":False})``.
Paul McCarthy's avatar
Paul McCarthy committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
* The :func:`fsl.utils.run.run` and :func:`fsl.utils.run.runfsl` functions
  (and hence all :mod:`fsl.wrappers` functions) have been modified to use
  ``fsl.wrappers.fsl_sub`` instead of ``fsl.utils.fslsub.submit``. This is an
  internal change which should not affect the usage of the ``run``, ``runfsl``
  or wrapper functions.


Deprecated
^^^^^^^^^^


* :class:`fsl.utils.fslsub.SubmitParams` and :func:`fsl.utils.fslsub.submit`
  have been deprecated in favour of using the ``fsl.wrappers.fsl_sub`` wrapper
  function.
Paul McCarthy's avatar
Paul McCarthy committed
57
58
59
* The :func:`fsl.utils.fslsub.info` function has been deprecated in favour of
  using the ``fsl_sub.report`` function, from the separate `fsl_sub
  <https://git.fmrib.ox.ac.uk/fsl/fsl_sub>`_ Python library.
Paul McCarthy's avatar
Paul McCarthy committed
60
61


Paul McCarthy's avatar
Paul McCarthy committed
62
63
64
65
66
67
68
69
3.6.4 (Tuesday 3rd August 2021)
-------------------------------


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
70
* New :func:`.epi_reg` wrapper function (!306).
Paul McCarthy's avatar
Paul McCarthy committed
71
72
73
* New :meth:`.fslmaths.kernel` and :meth:`.fslmaths.fmeanu` options on the
  :class:`.fslmaths` wrapper (!304).

Paul McCarthy's avatar
Paul McCarthy committed
74

Paul McCarthy's avatar
Paul McCarthy committed
75
76
77
78
79
80
81
82
83
84
85
86
87
3.6.3 (Wednesday 28th July 2021)
--------------------------------


Changed
^^^^^^^


* When creating an ``Image`` object with ``loadData=False``, the ``calcRange``
  argument is ignored, as it would otherwise cause the data to be loaded
  (!301).


Paul McCarthy's avatar
Paul McCarthy committed
88
3.6.2 (Wednesday 23rd June 2021)
Paul McCarthy's avatar
Paul McCarthy committed
89
90
91
92
93
94
95
--------------------------------


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
96
97
98
99
100
101
102
103
104
105
106
107
* The ``fsl.wrappers.fast`` wrapper passes ``-v`` to ``fast`` if ``v=True`` or
  ``verbose=True`` is specified.


3.6.1 (Thursday 27th May 2021)
------------------------------


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
108
109
110
* Removed the ``dataclasses`` backport from requirements (!297).


Paul McCarthy's avatar
Paul McCarthy committed
111
112
3.6.0 (Monday 19th April 2021)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
113
114
115
116
117


Changed
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
118

Paul McCarthy's avatar
Paul McCarthy committed
119
* The ``fslpy`` API ocumentation is now hosted at
Paul McCarthy's avatar
Paul McCarthy committed
120
  https://open.win.ox.ac.uk/pages/fsl/fslpy (!290).
Paul McCarthy's avatar
Paul McCarthy committed
121
122
* The :mod:`fsl` and :mod:`fsl.scripts` packages have been changed from being
  `pkgutil-style
123
  <https://packaging.python.org/guides/packaging-namespace-packages/#pkgutil-style-namespace-packages>`_
Paul McCarthy's avatar
Paul McCarthy committed
124
  namespace packages to now being `native
125
  <https://packaging.python.org/guides/packaging-namespace-packages/#native-namespace-packages>`_
Paul McCarthy's avatar
Paul McCarthy committed
126
  namespace packages (!290).
Paul McCarthy's avatar
Paul McCarthy committed
127
* The :class:`.TaskThread` now allows an error handler function to be
Paul McCarthy's avatar
Paul McCarthy committed
128
  specified, which is run on the :mod:`.idle` loop (!283).
Paul McCarthy's avatar
Paul McCarthy committed
129
* The :func:`.bids.loadMetadata` function no long resolves sym-links when
Paul McCarthy's avatar
Paul McCarthy committed
130
131
132
133
134
  determining whether a file is contained within a BIDS data set (!287).
* The :class:`.Image` class can now be created from a ``pathlib.Path`` object
  (!292).
* Some functions in the :mod:`.path` module can now be used with
  ``pathlib.Path`` objects (!293).
Paul McCarthy's avatar
Paul McCarthy committed
135

Paul McCarthy's avatar
Paul McCarthy committed
136

Paul McCarthy's avatar
Paul McCarthy committed
137
138
139
140
141
142
143
144
Deprecated
^^^^^^^^^^


* Deprecated a number of GUI-specific properties in the
  :mod:`fsl.utils.platform` module, including ``frozen``, ``haveGui``,
  ``canHaveGui``, ``inSSHSession``, ``inVNCSession``, ``wxPlatform``,
  ``wxFlavour``, ``glVersion``, ``glRenderer``, and ``glIsSoftwareRenderer``.
Paul McCarthy's avatar
Paul McCarthy committed
145
146
  Equivalent functions are being added to the ``fsleyes-widgets`` library
  (!285).
Paul McCarthy's avatar
Paul McCarthy committed
147
148
* The :mod:`fsl.utils.filetree` package has been deprecated, and will be
  removed in a future version of ``fslpy`` - it is now published as a separate
Paul McCarthy's avatar
Paul McCarthy committed
149
  library on [PyPI](https://pypi.org/project/file-tree/) (!286).
Paul McCarthy's avatar
Paul McCarthy committed
150
151


Paul McCarthy's avatar
Paul McCarthy committed
152
153
154
155
Fixed
^^^^^

* Fixed an edge-case in the :mod:`.gifti` module, where a surface with a
Paul McCarthy's avatar
Paul McCarthy committed
156
157
158
  single triangle was being loaded incorrectly (!288).
* Fixed an issue in the :func:`.func_to_cmd` function, where it was
  unintentionally leaving flie handles open (!291).
Paul McCarthy's avatar
Paul McCarthy committed
159
160


Paul McCarthy's avatar
Paul McCarthy committed
161

Paul McCarthy's avatar
Paul McCarthy committed
162
163
164
165
166
167
168
169
170
171
172
3.5.3 (Tuesday 9th February 2021)
---------------------------------


Fixed
^^^^^


* Fixed a bug in :func:`.featanalysis.loadClusterResults` (!281).


Paul McCarthy's avatar
Paul McCarthy committed
173
174
175
176
177
178
179
180
181
182
3.5.2 (Friday 29th January 2021)
---------------------------------


Fixed
^^^^^


* Adjusted the :func:`.dicom.scanDir` function so that it will set a
  default value for ``SeriesDescription`` if it is not present in the
Paul McCarthy's avatar
Paul McCarthy committed
183
184
  ``dcm2niix`` ``json`` output (!279).
* Fixed some issues with API documentation generation (!279).
Paul McCarthy's avatar
Paul McCarthy committed
185
186


Paul McCarthy's avatar
Paul McCarthy committed
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
3.5.1 (Thursday 21st January 2021)
----------------------------------


Added
^^^^^


* New :func:`.featanalysis.loadFsf` function, for loading arbitrary ``.fsf``
  files (!276).


Fixed
^^^^^


* Adjustments to :mod:`.dicom` tests to work with different versions of
  ``dcm2niix`` (!277).


Paul McCarthy's avatar
Paul McCarthy committed
207
208
3.5.0 (Wednesday 20th January 2021)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229


Added
^^^^^


* New ``fsl_anat.tree``, for use with the :mod:`.filetree` package (!264).
* New :func:`.fsl_prepare_fieldmap` wrapper function (!265).
* The :class:`.fslmaths` wrapper now supports the ``fslmaths -s`` option
  via the :meth:`.fslmaths.smooth` method (!271).


Fixed
^^^^^


* Windows/WSL-specific workaround to the :func:`fsl.utils.run.run` function to
  avoid console windows from popping up, when used from a graphical program
  (!272).


Paul McCarthy's avatar
Paul McCarthy committed
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
3.4.0 (Tuesday 20th October 2020)
---------------------------------


Added
^^^^^


* New :mod:`.tbss` wrapper functions for `TBSS
  <https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/TBSS>`_ commands.


Changed
^^^^^^^


* Calls to functions in the :mod:`.assertions` module are disabled when a
  wrapper function is called with ``cmdonly=True``.


Paul McCarthy's avatar
Paul McCarthy committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
3.3.3 (Wednesday 13th October 2020)
-----------------------------------


Changed
^^^^^^^


* The :func:`.fileOrImage` (and related) decorators will not manipulate the
  return value of a decorated function if an argument ``cmdonly=True`` is
  passed. This is so that wrapper functions will directly return the command
  that would be executed when ``cmdonly=True``.


Paul McCarthy's avatar
Paul McCarthy committed
264
265
266
267
268
269
270
271
272
273
274
275
276
3.3.2 (Tuesday 12th October 2020)
---------------------------------


Changed
^^^^^^^


* Most :func:`.wrapper` functions now accept an argument called ``cmdonly``
  which, if ``True``, will cause the generated command-line call to be
  returned, instead of executed.


Paul McCarthy's avatar
Paul McCarthy committed
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
3.3.1 (Thursday 8th October 2020)
---------------------------------


Changed
^^^^^^^


* The :func:`.affine.decompose` and :func:`.affine.compose` functions now
  have the ability to return/accept shear components.


Fixed
^^^^^


* Fixed a bug in the :func:`.affine.decompose` function which was corrupting
  the scale estimates when given an affine containing shears.

Paul McCarthy's avatar
Paul McCarthy committed
296

Paul McCarthy's avatar
Paul McCarthy committed
297
298
3.3.0 (Tuesday 22nd September 2020)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
299
300
301
302
303
304
305
306


Added
^^^^^

* New ported versions of various core FSL tools, including ``imrm``, ``imln``,
  ``imtest``, ``fsl_abspath``, ``remove_ext``, ``Text2Vest``, and
  ``Vest2Text``.
Paul McCarthy's avatar
Paul McCarthy committed
307
* New :func:`.gps` function, wrapping the FSL ``gps`` command.
Paul McCarthy's avatar
Paul McCarthy committed
308
* New :func:`.vest.loadVestFile` and :func:`.vest.generateVest` functions.
Paul McCarthy's avatar
Paul McCarthy committed
309
310
311
312
313
314
315


Changed
^^^^^^^


* Updates to the BIDS filetree specification.
Paul McCarthy's avatar
Paul McCarthy committed
316
317


Paul McCarthy's avatar
Paul McCarthy committed
318
319
Fixed
^^^^^
Paul McCarthy's avatar
Paul McCarthy committed
320
321


Paul McCarthy's avatar
Paul McCarthy committed
322
323
324
* The :class:`.CoefficientField` class now works with alternate reference
  images (i.e. a reference image with different dimensions to that which
  was originally used when the non-linear transformation was calculated).
Paul McCarthy's avatar
Paul McCarthy committed
325
326


Paul McCarthy's avatar
Paul McCarthy committed
327
328
329
330
331
332
333
334
335
336
337
3.2.2 (Thursday 9th July 2020)
------------------------------


Changed
^^^^^^^


* The :func:`.fslsub.func_to_cmd` function allows more fine-grained control
  over whether the script file is removed after the job has finished running.

Paul McCarthy's avatar
Paul McCarthy committed
338
339
340
341
342
343
344
345
346
347
348
349

3.2.1 (Tuesday 23rd June 2020)
------------------------------


Changed
^^^^^^^


* Minor updates to documentation.


Paul McCarthy's avatar
Paul McCarthy committed
350
351
352
353
354
355
356
357
358
359
3.2.0 (Thursday 11th June 2020)
-------------------------------


Added
^^^^^


* A new :func:`.fslsub.hold` function to wait on previously submitted jobs, to
  be used in place of the ``wait`` function.
Paul McCarthy's avatar
Paul McCarthy committed
360
361
362
363
364
365
366
367
368
369
370


Removed
^^^^^^^


* The :func:`.fslsub.wait` (and :func:`.run.wait`) function has been removed, as
  repeated calls to ``qstat`` can adversely affect the cluster job submission
  system.


Paul McCarthy's avatar
Paul McCarthy committed
371
372
3.1.0 (Thursday 21st May 2020)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
373
374


Paul McCarthy's avatar
Paul McCarthy committed
375
376
377
378
Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
379
* New :mod:`.cifti` module, providing classes and functions for working with
Paul McCarthy's avatar
Paul McCarthy committed
380
  `CIFTI <https://www.nitrc.org/projects/cifti/>`_ data.
Paul McCarthy's avatar
Paul McCarthy committed
381
382
383
384
385
386
* New :func:`.winpath` and :func:`wslpath` functions for working with paths
  when using FSL in a Windows Subsystem for Linux (WSL) environment.
* New :func:`.wslcmd` function for generating a path to a FSL command installed
  in a WSL environment.
* New :meth:`.Platform.fslwsl` attribute for detecting whether FSL is installed
  in a WSL environment.
Paul McCarthy's avatar
Paul McCarthy committed
387
388
389
390
391
392
393
394
395
396
397
398
* New :meth:`.Image.niftiDataType` property.
* The :class:`.FileTree` class has been updated to allow creation of
  deep copies via the new :meth:`.FileTree.copy` method.


Changed
^^^^^^^


* :func:`.Image` objects created from ``numpy`` arrays will be NIFTI1 or
  NIFTI2, depending on the value of the ``$FSLOUTPUTTYPE`` environment
  variable.
Paul McCarthy's avatar
Paul McCarthy committed
399
400


Paul McCarthy's avatar
Paul McCarthy committed
401
402
403
404
405
406
407
408
Fixed
^^^^^


* Updated the :func:`.fast` wrapper to support some single-character
  command-line flags.


Paul McCarthy's avatar
Paul McCarthy committed
409
410
411
412
413
414
415
416
417
418
3.0.1 (Wednesday 15th April 2020)
---------------------------------


Changed
^^^^^^^


* The :func:`.isMelodicDir` function now accepts directories that do not end
  with ``.ica``, as long as all required files are present.
Paul McCarthy's avatar
Paul McCarthy committed
419
420
* Added the ``dataclasses`` backport, so ``fslpy`` is now compatible with
  Python 3.6 again.
Paul McCarthy's avatar
Paul McCarthy committed
421
422


Paul McCarthy's avatar
Paul McCarthy committed
423
424
3.0.0 (Sunday 29th March 2020)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
425
426
427
428
429
430


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
431
432
* New wrapper functions for the FSL :class:`.fslstats`, :func:`.prelude` and
  :func:`applyxfm4D` commands.
Paul McCarthy's avatar
Paul McCarthy committed
433
434
435
* New ``firstDot`` option to the :func:`.path.getExt`,
  :func:`.path.removeExt`, and :func:`.path.splitExt`, functions, offering
  rudimentary support for double-barrelled filenames.
Paul McCarthy's avatar
Paul McCarthy committed
436
437
* The :func:`.nonlinear.applyDeformation` function now accepts a ``premat``
  affine, which is applied to the input image before the deformation field.
Paul McCarthy's avatar
Paul McCarthy committed
438
439
* New :class:`.SubmitParams` class, providing a higer level interface for
  cluster submission.
Paul McCarthy's avatar
Paul McCarthy committed
440
* New :meth:`.FileTree.load_json` and  :meth:`.FileTree.save_json` methods.
Paul McCarthy's avatar
Paul McCarthy committed
441

Paul McCarthy's avatar
Paul McCarthy committed
442

Paul McCarthy's avatar
Paul McCarthy committed
443
444
445
446
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
447
* ``fslpy`` now requires a minimum Python version of 3.7.
Paul McCarthy's avatar
Paul McCarthy committed
448
* The default value for the ``partial_fill`` option to :meth:`.FileTree.read`
Paul McCarthy's avatar
Paul McCarthy committed
449
450
451
  has been changed to ``False``. Accordingly, the :class:`.FileTreeQuery`
  calls the :meth:`.FileTree.partial_fill` method on the ``FileTree`` it is
  given.
Paul McCarthy's avatar
Paul McCarthy committed
452
453
* The :func:`.gifti.relatedFiles` function now supports files with
  BIDS-style naming conventions.
Paul McCarthy's avatar
Paul McCarthy committed
454
455
456
457
458
* The :func:`.run.run` and :func:`.run.runfsl` functions now pass through any
  additional keyword arguments to ``subprocess.Popen`` or, if ``submit=True``,
  to :func:`fslsub.submit`.
* The :func:`.fslsub.submit` function now accepts an ``env`` option, allowing
  environment variables to be specified.
Paul McCarthy's avatar
Paul McCarthy committed
459
460
* The :func:`.run.runfsl` function now raises an error on attempts to
  run a command which is not present in ``$FSLDIR/bin/`` (e.g. ``ls``).
Paul McCarthy's avatar
Paul McCarthy committed
461
462
463
* The :mod:`.bids` module has been updated to support files with any
  extension, not just those in the core BIDS specification (``.nii``,
  ``.nii.gz``, ``.json``, ``.tsv``).
Paul McCarthy's avatar
Paul McCarthy committed
464
465
466
467
468
469
470
* The return value of a function decorated with :func:`.fileOrImage`,
  :func:`.fileOrArray`, or :func:`.fileOrText` is now accessed via an attribute
  called ``stdout``, instead of ``output``.
* Output files of functions decorated with :func:`.fileOrImage`,
  :func:`.fileOrArray`, or :func:`.fileOrText`, which have been loaded via the
  :attr:`.LOAD` symbol, can now be accessed as attributes of the returned
  results object, in addition to being accessed as dict items.
Paul McCarthy's avatar
Paul McCarthy committed
471
* Wrapper functions decorated with the :func:`.fileOrImage`,
Paul McCarthy's avatar
Paul McCarthy committed
472
  :func:`.fileOrArray`, or :func:`.fileOrText` decorators will now pass all
Paul McCarthy's avatar
Paul McCarthy committed
473
474
475
476
  arguments and return values through unchanged if an argument called ``submit``
  is passed in, and is set to ``True`` (or any non-``False``
  value). Furthermore, in such a scenario a :exc:`ValueError` will be raised if
  any in-memory objects or ``LOAD`` symbols are passed.
Paul McCarthy's avatar
Paul McCarthy committed
477
478
479
* The :func:`.fileOrText` decorator has been updated to work with input
  values - file paths must be passed in as ``pathlib.Path`` objects, so they
  can be differentiated from input values.
Paul McCarthy's avatar
Paul McCarthy committed
480
481
* Loaded :class:`.Image` objects returned by :mod:`fsl.wrappers` functions
  are now named according to the wrapper function argument name.
Paul McCarthy's avatar
Paul McCarthy committed
482
483


Paul McCarthy's avatar
Paul McCarthy committed
484
485
486
487
488
489
490
Fixed
^^^^^


* Updated the :func:`.prepareArgs` function to use ``shlex.split`` when
  preparing shell command arguments, instead of performing a naive whitespace
  split.
Paul McCarthy's avatar
Paul McCarthy committed
491
492
* Fixed some bugs in the :func:`.fslsub.info` and :func:`.fslinfo.wait`
  functions.
Paul McCarthy's avatar
Paul McCarthy committed
493
494
* Fixed the :func:`.DeformationField.transform` method so it works with
  a single set of coordinates.
Paul McCarthy's avatar
Paul McCarthy committed
495
496
* :class:`.Image` creation does not fail if ``loadMeta`` is set, and a
  sidecar file containing invalid JSON is present.
Paul McCarthy's avatar
Paul McCarthy committed
497

Paul McCarthy's avatar
Paul McCarthy committed
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
Removed
^^^^^^^


* Removed the deprecated ``.StatisticAtlas.proportions``,
  ``.StatisticAtlas.coordProportions``, and
  ``.StatisticAtlas.maskProportions`` methods.
* Removed the deprecated ``indexed`` option to :meth:`.Image.__init__`.
* Removed the deprecated ``.Image.resample`` method.
* Removed the deprecated ``.image.loadIndexedImageFile`` function.
* Removed the deprecatd ``.FileTreeQuery.short_names`` and
  ``.Match.short_name`` properties.
* Removed the deprecated ``.idle.inIdle``, ``.idle.cancelIdle``,
  ``.idle.idleReset``, ``.idle.getIdleTimeout``, and
  ``.idle.setIdleTimeout`` functions.
* Removed the deprecated ``resample.calculateMatrix`` function.


Paul McCarthy's avatar
Paul McCarthy committed
516
517
518
519
520
521
522
523
524
525
526
527
528
529
2.8.4 (Monday 2nd March 2020)
-----------------------------


Added
^^^^^


* Added a new ``partial_fill`` option to :meth:`.FileTree.read`, which
  effectively eliminates any variables which only have one value. This was
  added to accommodate some behavioural changes that were introduced in 2.8.2.



Paul McCarthy's avatar
Paul McCarthy committed
530
531
532
533
534
535
536
537
538
539
2.8.3 (Friday 28th February 2020)
---------------------------------


Fixed
^^^^^


* Fixed a bug in the :meth:`.Image.save` method.

Paul McCarthy's avatar
Paul McCarthy committed
540
541
542
543
544
545
546
547
548
549
550
551

2.8.2 (Thursday 27th February 2020)
-----------------------------------


Fixed
^^^^^


* Fixed some subtle bugs in the :func:`.filetree.utils.get_all` function.


Paul McCarthy's avatar
Paul McCarthy committed
552
553
2.8.1 (Thursday 20th February 2020)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
554
555
556
557
558
559
560
561
562


Fixed
^^^^^


* Fixed a bug where an error would be raised on attempts to load an image file
  without a BIDS-compatible name from a BIDS-like directory.

Paul McCarthy's avatar
Paul McCarthy committed
563

Paul McCarthy's avatar
Paul McCarthy committed
564
565
2.8.0 (Wednesday 29th January 2020)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
566
567


Paul McCarthy's avatar
Paul McCarthy committed
568
569
570
571
572
573
574
575
Added
^^^^^


* New :meth:`.Nifti.adjust` method, for creating a copy of a :class:`.Nifti`
  header with adjusted shape, pixdims, and affine. This can be useful for
  creating a resampling reference.
* New :func:`.affine.rescale` function, for adjusting a scaling matrix.
Paul McCarthy's avatar
Paul McCarthy committed
576
577
* New :func:`.mghimage.voxToSurfMat` function, for creating a
  voxel-to-freesurfer affine transform from any image.
Paul McCarthy's avatar
Paul McCarthy committed
578
579


Paul McCarthy's avatar
Paul McCarthy committed
580
581
582
583
584
585
586
587
588
589
Changed
^^^^^^^


* The :class:`.ImageWrapper` now maintains its own image data cache, rather
  than depending on ``nibabel``.
* Internal changes to avoid using the deprecated
  ``nibabel.dataobj_images.DataobjImage.get_data`` method.


Paul McCarthy's avatar
Paul McCarthy committed
590
591
592
593
594
Fixed
^^^^^


* Improved the algorithm used by the :func:`.mesh.needsFixing` function.
Paul McCarthy's avatar
Paul McCarthy committed
595
596
* The :meth:`.fslmaths.run` method now accepts :attr:`.wrappers.LOAD` as an
  output specification.
Paul McCarthy's avatar
Paul McCarthy committed
597
598
* Fixed a bug in the :class:`.Mesh` class to prevent indices from being loaded
  as floating point type.
Paul McCarthy's avatar
Paul McCarthy committed
599
* Fixed a bug in the :func:`.resample` function.
Paul McCarthy's avatar
Paul McCarthy committed
600
601
* Fixed a bug in the :class:`.MGHImage` class, which was causing pixdims to
  be overridden by scales derived from the affine.
Paul McCarthy's avatar
Paul McCarthy committed
602
603


Paul McCarthy's avatar
Paul McCarthy committed
604
605
606
607
608
609
610
611
Deprecated
^^^^^^^^^^


* :func:`.calculateMatrix` - its functionality has been moved to the
  :func:`.affine.rescale` function.


Paul McCarthy's avatar
Paul McCarthy committed
612
613
2.7.0 (Wednesday 6th November 2019)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
614
615
616
617
618
619
620
621
622


Added
^^^^^


* New ``until`` option to the :func:`.idle.block` function.
* New :meth:`.Idle.neverQueue` setting, which can be used to force all
  tasks passed to :func:`.idle.idle` to be executed synchronously.
Paul McCarthy's avatar
Paul McCarthy committed
623
624
* New :meth:`.IdleLoop.synchronous` context manager, to temporarily change the
  value of :meth:`.IdleLoop.neverQueue`.
Paul McCarthy's avatar
Paul McCarthy committed
625
626
* New :mod:`.bids` module, containing a few simple functions for working with
  `BIDS <https://bids.neuroimaging.io>`_ datasets.
Paul McCarthy's avatar
Paul McCarthy committed
627
628
629
* New :func:`.image.loadMetadata` function, and ``loadMeta`` option to the
  :class:`.Image` class, to automatically find and load any sidecar JSON files
  associated with an image file.
Paul McCarthy's avatar
Paul McCarthy committed
630
631
632
633
634
635


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
636
* Internal reorganisation in the :mod:`.idle` module.
Paul McCarthy's avatar
Paul McCarthy committed
637
638


Paul McCarthy's avatar
Paul McCarthy committed
639
640
641
642
643
644
645
646
Fixed
^^^^^


* Fixed incorrect usage of ``setuptools.find_packages``, which was causing
  unit tests to be installed.


Paul McCarthy's avatar
Paul McCarthy committed
647
648
649
650
651
652
653
654
655
656
657
Deprecated
^^^^^^^^^^


* :func:`.idle.inIdle` - replaced by :meth:`.IdleLoop.inIdle`.
* :func:`.idle.cancelIdle` - replaced by :meth:`.IdleLoop.cancelIdle`.
* :func:`.idle.idleReser` - replaced by :meth:`.IdleLoop.idleReset`.
* :func:`.idle.getIdleTimeout` - replaced by :meth:`.IdleLoop.callRate`.
* :func:`.idle.setIdleTimeout` - replaced by :meth:`.IdleLoop.callRate`.


Paul McCarthy's avatar
Paul McCarthy committed
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
2.6.2 (Monday 7th October 2019)
-------------------------------


Changed
^^^^^^^


* Added a debugging hook in the :mod:`.idle` module.
* The :func:`.fslsub.submit` function is now more flexible in the way it
  accepts the command and input arguments.
* The :func:`.run.prepareArgs` function has been renamed (from
  ``_prepareArgs``).


Paul McCarthy's avatar
Paul McCarthy committed
673
674
675
676
677
678
679
680
681
682
683
684
2.6.1 (Thursday 19th September 2019)
------------------------------------


Changed
^^^^^^^


* ``fslpy`` is no longer tested against Python 3.5, and is now tested against
  Python 3.6, 3.7, and 3.8.


Paul McCarthy's avatar
Paul McCarthy committed
685
686
2.6.0 (Tuesday 10th September 2019)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
687
688


Paul McCarthy's avatar
Paul McCarthy committed
689
690
691
692
693
Added
^^^^^


* New :meth:`.Image.iscomplex` attribute.
Paul McCarthy's avatar
Paul McCarthy committed
694
* Support for a new ``Statistic`` atlas type.
Paul McCarthy's avatar
Paul McCarthy committed
695
696


Paul McCarthy's avatar
Paul McCarthy committed
697
698
699
700
701
702
Changed
^^^^^^^


* The :class:`.Cache` class has a new ``lru`` option, allowing it to be used
  as a least-recently-used cache.
Paul McCarthy's avatar
Paul McCarthy committed
703
704
* The :mod:`fsl.utils.filetree` module has been refactored to make it easier
  for the :mod:`.query` module to work with file tree hierarchies.
Paul McCarthy's avatar
Paul McCarthy committed
705
706
707
* The :meth:`.LabelAtlas.get` method has a new ``binary`` flag, allowing
  either a binary mask, or a mask with the original label value, to be
  returned.
Paul McCarthy's avatar
Paul McCarthy committed
708
709
* The :mod:`.dicom` module has been updated to work with the latest version of
  ``dcm2niix``.
Paul McCarthy's avatar
Paul McCarthy committed
710
711
712
713
714
715
716
717
718
719
720


Deprecated
^^^^^^^^^^


* :meth:`.ProbabilisticAtlas.proportions`,
  :meth:`.ProbabilisticAtlas.maskProportions`, and
  :meth:`.ProbabilisticAtlas.labelProportions` have been deprecated in favour
  of :meth:`.StatisticAtlas.values`, :meth:`.StatisticAtlas.maskValues`, and
  :meth:`.StatisticAtlas.labelValues`
Paul McCarthy's avatar
Paul McCarthy committed
721
722


Paul McCarthy's avatar
Paul McCarthy committed
723
724
2.5.0 (Tuesday 6th August 2019)
-------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
725
726


Paul McCarthy's avatar
Paul McCarthy committed
727
728
729
730
Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
731
732
733
734
735
736
737
738
739
740
741
742
* New :meth:`.Image.getAffine` method, for retrieving an affine between any of
  the voxel, FSL, or world coordinate systems.
* New :mod:`fsl.transforms` package, which contains classes and functions for
  working with linear and non-linear FLIRT and FNIRT transformations.
* New static methods :meth:`.Nifti.determineShape`,
  :meth:`.Nifti.determineAffine`, :meth:`.Nifti.generateAffines`, and
  :meth:`.Nifti.identifyAffine`.
* New prototype :mod:`fsl.transforms.x5`  module, for reading/writing linear
  and non-linear X5 files (*preliminary release, subject to change*).
* New prototype :mod:`.fsl_convert_x5` :mod:`.fsl_apply_x5` programs, for
  working with X5 transformations (*preliminary release, subject to change*).

Paul McCarthy's avatar
Paul McCarthy committed
743
744


Paul McCarthy's avatar
Paul McCarthy committed
745
746
747
748
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
749
750
* The :mod:`.vest.looksLikeVestLutFile` function has been made slightly more
  lenient.
Paul McCarthy's avatar
Paul McCarthy committed
751
752
753
754
755
756
757
* `h5py <https://www.h5py.org/>`_ has been added to the ``fslpy`` dependencies.


Deprecated
^^^^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
758
* The :mod:`fsl.utils.transform` module has been deprecated; its functions can
Paul McCarthy's avatar
Paul McCarthy committed
759
760
  now be found in the :mod:`fsl.transforms.affine` and
  :mod:`fsl.transform.flirt` modules.
Paul McCarthy's avatar
Paul McCarthy committed
761
762


Paul McCarthy's avatar
Paul McCarthy committed
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
2.4.0 (Wednesday July 24th 2019)
--------------------------------


Added
^^^^^


* New :mod:`.image.roi` module, for extracting 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.


Paul McCarthy's avatar
Paul McCarthy committed
783
784
785
786
787
788
789
790
791
792
793
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
794
795
2.3.0 (Tuesday June 25th 2019)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
796
797
798
799
800
801


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
802
803
804
805
806
* 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
807
808
* New :attr:`.Image.nvals` property, for use with ``RGB24``/``RGBA32``
  images.
Paul McCarthy's avatar
Paul McCarthy committed
809
810
811
812
813
814
815
816
817
818
819
820
821
822
* 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
823
* Fixed a bug in the :meth:`.GitfitMesh.loadVertices` method.
Paul McCarthy's avatar
Paul McCarthy committed
824
825
* 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
826
827


Paul McCarthy's avatar
Paul McCarthy committed
828
829
2.2.0 (Wednesday May 8th 2019)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
830
831


Paul McCarthy's avatar
Paul McCarthy committed
832
833
834
835
836
837
838
839
840
841
842
843
844
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
845
846
847
848
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
849
850
851
852
853
854
855
* 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
856
857
858
859
Fixed
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
860
* Minor fixes to some :mod:`.filetree.filetree` tree definitions.
Paul McCarthy's avatar
Paul McCarthy committed
861
862


Paul McCarthy's avatar
Paul McCarthy committed
863
864
865
866
867
868
Deprecated
^^^^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
871
872
2.1.0 (Saturday April 13th 2019)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
873
874
875
876
877
878
879
880


Added
^^^^^


* New tensor conversion routines in the :mod:`.dtifit` module (Michiel
  Cottaar).
Paul McCarthy's avatar
Paul McCarthy committed
881
882
* 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
883
884


Paul McCarthy's avatar
Paul McCarthy committed
885
886
887
888
889
Changed
^^^^^^^


* The :class:`.GiftiMesh` class no longer creates copies of the mesh
Paul McCarthy's avatar
Paul McCarthy committed
890
891
  vertex/index arrays. This means that, these arrays will be flagged as
  read-only.
Paul McCarthy's avatar
Paul McCarthy committed
892
893
894
* 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
895
896


Paul McCarthy's avatar
Paul McCarthy committed
897
898
899
900
901
902
903
904
905
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
906
907
908
909
910
911
912
913
914
915
916
917
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
918
919
2.0.0 (Friday March 20th 2019)
------------------------------
920
921


922
923
924
Added
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
925
* New :mod:`fsl.utils.filetree` package for defining and working with
Paul McCarthy's avatar
Paul McCarthy committed
926
  file/directory templates (Michiel Cottaar).
Paul McCarthy's avatar
Paul McCarthy committed
927
* Simple built-in :mod:`.deprecated` decorator.
Paul McCarthy's avatar
Paul McCarthy committed
928
* New :mod:`fsl.data.utils` module, which currently contains one function
929
  :func:`.guessType`, which guesses the data type of a file/directory path.
930
* New :func:`.commonBase` function for finding the common prefix of a set of
Paul McCarthy's avatar
Paul McCarthy committed
931
  file/directory paths.
932
933


934
935
936
Changed
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
937

938
* Removed support for Python 2.7 and 3.4.
939
940
941
* 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
942
* The :class:`.GiftiMesh` class can now load surface files which contain
Paul McCarthy's avatar
Paul McCarthy committed
943
944
945
  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
946
947


Paul McCarthy's avatar
Paul McCarthy committed
948
949
950
951
952
953
Removed
^^^^^^^

* Many deprecated items removed.


Paul McCarthy's avatar
Paul McCarthy committed
954
955
956
957
958
959
960
961
Deprecated
^^^^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
962
963
964
965
1.13.3 (Friday February 8th 2019)
---------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
966
967
968
Fixed
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
969

970
* Fixed an issue with the :func:`.dicom.loadSeries` using memory-mapping for
Paul McCarthy's avatar
Paul McCarthy committed
971
  image files that would subsequently be deleted.
Paul McCarthy's avatar
Paul McCarthy committed
972
* Fixed an issue in the :class:`.GiftiMesh` class, where
Paul McCarthy's avatar
Paul McCarthy committed
973
974
975
  ``numpy``/``nibabel`` was returning read-only index arrays.


Paul McCarthy's avatar
Paul McCarthy committed
976
977
978
979
980
981
982
983
1.13.2 (Friday November 30th 2018)
----------------------------------


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
984
985
* The :meth:`.Image.resample` method now supports images with more than three
  dimensions.
Michiel Cottaar's avatar
Michiel Cottaar committed
986
987
988
989
* 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.
990
991


Paul McCarthy's avatar
Paul McCarthy committed
992
993
Fixed
^^^^^
Paul McCarthy's avatar
Paul McCarthy committed
994

Paul McCarthy's avatar
Paul McCarthy committed
995
996
997
998
999
1000

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


1.13.1 (Friday November 23rd 2018)
----------------------------------
For faster browsing, not all history is shown. View entire blame