CHANGELOG.rst 40.8 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.6.1 (Thursday 27th April 2021)
--------------------------------


Changed
^^^^^^^


* Removed the ``dataclasses`` backport from requirements (!297).


Paul McCarthy's avatar
Paul McCarthy committed
17
18
3.6.0 (Monday 19th April 2021)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
19
20
21
22
23


Changed
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
24

Paul McCarthy's avatar
Paul McCarthy committed
25
* The ``fslpy`` API ocumentation is now hosted at
Paul McCarthy's avatar
Paul McCarthy committed
26
  https://open.win.ox.ac.uk/pages/fsl/fslpy (!290).
Paul McCarthy's avatar
Paul McCarthy committed
27
28
* The :mod:`fsl` and :mod:`fsl.scripts` packages have been changed from being
  `pkgutil-style
29
  <https://packaging.python.org/guides/packaging-namespace-packages/#pkgutil-style-namespace-packages>`_
Paul McCarthy's avatar
Paul McCarthy committed
30
  namespace packages to now being `native
31
  <https://packaging.python.org/guides/packaging-namespace-packages/#native-namespace-packages>`_
Paul McCarthy's avatar
Paul McCarthy committed
32
  namespace packages (!290).
Paul McCarthy's avatar
Paul McCarthy committed
33
* The :class:`.TaskThread` now allows an error handler function to be
Paul McCarthy's avatar
Paul McCarthy committed
34
  specified, which is run on the :mod:`.idle` loop (!283).
Paul McCarthy's avatar
Paul McCarthy committed
35
* The :func:`.bids.loadMetadata` function no long resolves sym-links when
Paul McCarthy's avatar
Paul McCarthy committed
36
37
38
39
40
  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
41

Paul McCarthy's avatar
Paul McCarthy committed
42

Paul McCarthy's avatar
Paul McCarthy committed
43
44
45
46
47
48
49
50
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
51
52
  Equivalent functions are being added to the ``fsleyes-widgets`` library
  (!285).
Paul McCarthy's avatar
Paul McCarthy committed
53
54
* 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
55
  library on [PyPI](https://pypi.org/project/file-tree/) (!286).
Paul McCarthy's avatar
Paul McCarthy committed
56
57


Paul McCarthy's avatar
Paul McCarthy committed
58
59
60
61
Fixed
^^^^^

* Fixed an edge-case in the :mod:`.gifti` module, where a surface with a
Paul McCarthy's avatar
Paul McCarthy committed
62
63
64
  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
65
66


Paul McCarthy's avatar
Paul McCarthy committed
67

Paul McCarthy's avatar
Paul McCarthy committed
68
69
70
71
72
73
74
75
76
77
78
3.5.3 (Tuesday 9th February 2021)
---------------------------------


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
79
80
81
82
83
84
85
86
87
88
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
89
90
  ``dcm2niix`` ``json`` output (!279).
* Fixed some issues with API documentation generation (!279).
Paul McCarthy's avatar
Paul McCarthy committed
91
92


Paul McCarthy's avatar
Paul McCarthy committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
113
114
3.5.0 (Wednesday 20th January 2021)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135


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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
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
170
171
172
173
174
175
176
177
178
179
180
181
182
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
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
202

Paul McCarthy's avatar
Paul McCarthy committed
203
204
3.3.0 (Tuesday 22nd September 2020)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
205
206
207
208
209
210
211
212


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
213
* New :func:`.gps` function, wrapping the FSL ``gps`` command.
Paul McCarthy's avatar
Paul McCarthy committed
214
* New :func:`.vest.loadVestFile` and :func:`.vest.generateVest` functions.
Paul McCarthy's avatar
Paul McCarthy committed
215
216
217
218
219
220
221


Changed
^^^^^^^


* Updates to the BIDS filetree specification.
Paul McCarthy's avatar
Paul McCarthy committed
222
223


Paul McCarthy's avatar
Paul McCarthy committed
224
225
Fixed
^^^^^
Paul McCarthy's avatar
Paul McCarthy committed
226
227


Paul McCarthy's avatar
Paul McCarthy committed
228
229
230
* 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
231
232


Paul McCarthy's avatar
Paul McCarthy committed
233
234
235
236
237
238
239
240
241
242
243
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
244
245
246
247
248
249
250
251
252
253
254
255

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


Changed
^^^^^^^


* Minor updates to documentation.


Paul McCarthy's avatar
Paul McCarthy committed
256
257
258
259
260
261
262
263
264
265
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
266
267
268
269
270
271
272
273
274
275
276


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
277
278
3.1.0 (Thursday 21st May 2020)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
279
280


Paul McCarthy's avatar
Paul McCarthy committed
281
282
283
284
Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
285
* New :mod:`.cifti` module, providing classes and functions for working with
Paul McCarthy's avatar
Paul McCarthy committed
286
  `CIFTI <https://www.nitrc.org/projects/cifti/>`_ data.
Paul McCarthy's avatar
Paul McCarthy committed
287
288
289
290
291
292
* 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
293
294
295
296
297
298
299
300
301
302
303
304
* 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
305
306


Paul McCarthy's avatar
Paul McCarthy committed
307
308
309
310
311
312
313
314
Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
315
316
317
318
319
320
321
322
323
324
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
325
326
* Added the ``dataclasses`` backport, so ``fslpy`` is now compatible with
  Python 3.6 again.
Paul McCarthy's avatar
Paul McCarthy committed
327
328


Paul McCarthy's avatar
Paul McCarthy committed
329
330
3.0.0 (Sunday 29th March 2020)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
331
332
333
334
335
336


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
337
338
* New wrapper functions for the FSL :class:`.fslstats`, :func:`.prelude` and
  :func:`applyxfm4D` commands.
Paul McCarthy's avatar
Paul McCarthy committed
339
340
341
* 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
342
343
* 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
344
345
* New :class:`.SubmitParams` class, providing a higer level interface for
  cluster submission.
Paul McCarthy's avatar
Paul McCarthy committed
346
* New :meth:`.FileTree.load_json` and  :meth:`.FileTree.save_json` methods.
Paul McCarthy's avatar
Paul McCarthy committed
347

Paul McCarthy's avatar
Paul McCarthy committed
348

Paul McCarthy's avatar
Paul McCarthy committed
349
350
351
352
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
353
* ``fslpy`` now requires a minimum Python version of 3.7.
Paul McCarthy's avatar
Paul McCarthy committed
354
* The default value for the ``partial_fill`` option to :meth:`.FileTree.read`
Paul McCarthy's avatar
Paul McCarthy committed
355
356
357
  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
358
359
* The :func:`.gifti.relatedFiles` function now supports files with
  BIDS-style naming conventions.
Paul McCarthy's avatar
Paul McCarthy committed
360
361
362
363
364
* 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
365
366
* 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
367
368
369
* 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
370
371
372
373
374
375
376
* 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
377
* Wrapper functions decorated with the :func:`.fileOrImage`,
Paul McCarthy's avatar
Paul McCarthy committed
378
  :func:`.fileOrArray`, or :func:`.fileOrText` decorators will now pass all
Paul McCarthy's avatar
Paul McCarthy committed
379
380
381
382
  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
383
384
385
* 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
386
387
* 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
388
389


Paul McCarthy's avatar
Paul McCarthy committed
390
391
392
393
394
395
396
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
397
398
* Fixed some bugs in the :func:`.fslsub.info` and :func:`.fslinfo.wait`
  functions.
Paul McCarthy's avatar
Paul McCarthy committed
399
400
* Fixed the :func:`.DeformationField.transform` method so it works with
  a single set of coordinates.
Paul McCarthy's avatar
Paul McCarthy committed
401
402
* :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
403

Paul McCarthy's avatar
Paul McCarthy committed
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
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
436
437
438
439
440
441
442
443
444
445
2.8.3 (Friday 28th February 2020)
---------------------------------


Fixed
^^^^^


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

Paul McCarthy's avatar
Paul McCarthy committed
446
447
448
449
450
451
452
453
454
455
456
457

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
458
459
2.8.1 (Thursday 20th February 2020)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
460
461
462
463
464
465
466
467
468


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
469

Paul McCarthy's avatar
Paul McCarthy committed
470
471
2.8.0 (Wednesday 29th January 2020)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
472
473


Paul McCarthy's avatar
Paul McCarthy committed
474
475
476
477
478
479
480
481
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
482
483
* New :func:`.mghimage.voxToSurfMat` function, for creating a
  voxel-to-freesurfer affine transform from any image.
Paul McCarthy's avatar
Paul McCarthy committed
484
485


Paul McCarthy's avatar
Paul McCarthy committed
486
487
488
489
490
491
492
493
494
495
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
496
497
498
499
500
Fixed
^^^^^


* Improved the algorithm used by the :func:`.mesh.needsFixing` function.
Paul McCarthy's avatar
Paul McCarthy committed
501
502
* The :meth:`.fslmaths.run` method now accepts :attr:`.wrappers.LOAD` as an
  output specification.
Paul McCarthy's avatar
Paul McCarthy committed
503
504
* 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
505
* Fixed a bug in the :func:`.resample` function.
Paul McCarthy's avatar
Paul McCarthy committed
506
507
* 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
508
509


Paul McCarthy's avatar
Paul McCarthy committed
510
511
512
513
514
515
516
517
Deprecated
^^^^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
518
519
2.7.0 (Wednesday 6th November 2019)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
520
521
522
523
524
525
526
527
528


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
529
530
* New :meth:`.IdleLoop.synchronous` context manager, to temporarily change the
  value of :meth:`.IdleLoop.neverQueue`.
Paul McCarthy's avatar
Paul McCarthy committed
531
532
* 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
533
534
535
* 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
536
537
538
539
540
541


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
542
* Internal reorganisation in the :mod:`.idle` module.
Paul McCarthy's avatar
Paul McCarthy committed
543
544


Paul McCarthy's avatar
Paul McCarthy committed
545
546
547
548
549
550
551
552
Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
553
554
555
556
557
558
559
560
561
562
563
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
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
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
579
580
581
582
583
584
585
586
587
588
589
590
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
591
592
2.6.0 (Tuesday 10th September 2019)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
593
594


Paul McCarthy's avatar
Paul McCarthy committed
595
596
597
598
599
Added
^^^^^


* New :meth:`.Image.iscomplex` attribute.
Paul McCarthy's avatar
Paul McCarthy committed
600
* Support for a new ``Statistic`` atlas type.
Paul McCarthy's avatar
Paul McCarthy committed
601
602


Paul McCarthy's avatar
Paul McCarthy committed
603
604
605
606
607
608
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
609
610
* 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
611
612
613
* 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
614
615
* The :mod:`.dicom` module has been updated to work with the latest version of
  ``dcm2niix``.
Paul McCarthy's avatar
Paul McCarthy committed
616
617
618
619
620
621
622
623
624
625
626


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
627
628


Paul McCarthy's avatar
Paul McCarthy committed
629
630
2.5.0 (Tuesday 6th August 2019)
-------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
631
632


Paul McCarthy's avatar
Paul McCarthy committed
633
634
635
636
Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
637
638
639
640
641
642
643
644
645
646
647
648
* 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
649
650


Paul McCarthy's avatar
Paul McCarthy committed
651
652
653
654
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
655
656
* The :mod:`.vest.looksLikeVestLutFile` function has been made slightly more
  lenient.
Paul McCarthy's avatar
Paul McCarthy committed
657
658
659
660
661
662
663
* `h5py <https://www.h5py.org/>`_ has been added to the ``fslpy`` dependencies.


Deprecated
^^^^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
664
* The :mod:`fsl.utils.transform` module has been deprecated; its functions can
Paul McCarthy's avatar
Paul McCarthy committed
665
666
  now be found in the :mod:`fsl.transforms.affine` and
  :mod:`fsl.transform.flirt` modules.
Paul McCarthy's avatar
Paul McCarthy committed
667
668


Paul McCarthy's avatar
Paul McCarthy committed
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
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
689
690
691
692
693
694
695
696
697
698
699
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
700
701
2.3.0 (Tuesday June 25th 2019)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
702
703
704
705
706
707


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
708
709
710
711
712
* 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
713
714
* New :attr:`.Image.nvals` property, for use with ``RGB24``/``RGBA32``
  images.
Paul McCarthy's avatar
Paul McCarthy committed
715
716
717
718
719
720
721
722
723
724
725
726
727
728
* 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
729
* Fixed a bug in the :meth:`.GitfitMesh.loadVertices` method.
Paul McCarthy's avatar
Paul McCarthy committed
730
731
* 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
732
733


Paul McCarthy's avatar
Paul McCarthy committed
734
735
2.2.0 (Wednesday May 8th 2019)
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
736
737


Paul McCarthy's avatar
Paul McCarthy committed
738
739
740
741
742
743
744
745
746
747
748
749
750
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
751
752
753
754
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
755
756
757
758
759
760
761
* 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
762
763
764
765
Fixed
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
766
* Minor fixes to some :mod:`.filetree.filetree` tree definitions.
Paul McCarthy's avatar
Paul McCarthy committed
767
768


Paul McCarthy's avatar
Paul McCarthy committed
769
770
771
772
773
774
Deprecated
^^^^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
777
778
2.1.0 (Saturday April 13th 2019)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
779
780
781
782
783
784
785
786


Added
^^^^^


* New tensor conversion routines in the :mod:`.dtifit` module (Michiel
  Cottaar).
Paul McCarthy's avatar
Paul McCarthy committed
787
788
* 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
789
790


Paul McCarthy's avatar
Paul McCarthy committed
791
792
793
794
795
Changed
^^^^^^^


* The :class:`.GiftiMesh` class no longer creates copies of the mesh
Paul McCarthy's avatar
Paul McCarthy committed
796
797
  vertex/index arrays. This means that, these arrays will be flagged as
  read-only.
Paul McCarthy's avatar
Paul McCarthy committed
798
799
800
* 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
801
802


Paul McCarthy's avatar
Paul McCarthy committed
803
804
805
806
807
808
809
810
811
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
812
813
814
815
816
817
818
819
820
821
822
823
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
824
825
2.0.0 (Friday March 20th 2019)
------------------------------
826
827


828
829
830
Added
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
831
* New :mod:`fsl.utils.filetree` package for defining and working with
Paul McCarthy's avatar
Paul McCarthy committed
832
  file/directory templates (Michiel Cottaar).
Paul McCarthy's avatar
Paul McCarthy committed
833
* Simple built-in :mod:`.deprecated` decorator.
Paul McCarthy's avatar
Paul McCarthy committed
834
* New :mod:`fsl.data.utils` module, which currently contains one function
835
  :func:`.guessType`, which guesses the data type of a file/directory path.
836
* New :func:`.commonBase` function for finding the common prefix of a set of
Paul McCarthy's avatar
Paul McCarthy committed
837
  file/directory paths.
838
839


840
841
842
Changed
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
843

844
* Removed support for Python 2.7 and 3.4.
845
846
847
* 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
848
* The :class:`.GiftiMesh` class can now load surface files which contain
Paul McCarthy's avatar
Paul McCarthy committed
849
850
851
  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
852
853


Paul McCarthy's avatar
Paul McCarthy committed
854
855
856
857
858
859
Removed
^^^^^^^

* Many deprecated items removed.


Paul McCarthy's avatar
Paul McCarthy committed
860
861
862
863
864
865
866
867
Deprecated
^^^^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
868
869
870
871
1.13.3 (Friday February 8th 2019)
---------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
872
873
874
Fixed
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
875

876
* Fixed an issue with the :func:`.dicom.loadSeries` using memory-mapping for
Paul McCarthy's avatar
Paul McCarthy committed
877
  image files that would subsequently be deleted.
Paul McCarthy's avatar
Paul McCarthy committed
878
* Fixed an issue in the :class:`.GiftiMesh` class, where
Paul McCarthy's avatar
Paul McCarthy committed
879
880
881
  ``numpy``/``nibabel`` was returning read-only index arrays.


Paul McCarthy's avatar
Paul McCarthy committed
882
883
884
885
886
887
888
889
1.13.2 (Friday November 30th 2018)
----------------------------------


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
890
891
* The :meth:`.Image.resample` method now supports images with more than three
  dimensions.
Michiel Cottaar's avatar
Michiel Cottaar committed
892
893
894
895
* 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.
896
897


Paul McCarthy's avatar
Paul McCarthy committed
898
899
Fixed
^^^^^
Paul McCarthy's avatar
Paul McCarthy committed
900

Paul McCarthy's avatar
Paul McCarthy committed
901
902
903
904
905
906

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


1.13.1 (Friday November 23rd 2018)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
907
908


Paul McCarthy's avatar
Paul McCarthy committed
909
910
911
912
Fixed
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
913
* Added a missing ``image`` attribute in the :class:`.VoxelwiseConfoundEV`
Paul McCarthy's avatar
Paul McCarthy committed
914
  class.
Paul McCarthy's avatar
Paul McCarthy committed
915
916
917
* 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
918
919


Paul McCarthy's avatar
Paul McCarthy committed
920
921
1.13.0 (Thursday 22nd November 2018)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
922

Paul McCarthy's avatar
Paul McCarthy committed
923
924
925
926

Added
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
927
* New wrapper functions for :func:`.fsl_anat`, :func:`.applytopup` (Martin
Paul McCarthy's avatar
Paul McCarthy committed
928
  Craig).
Paul McCarthy's avatar
Paul McCarthy committed
929
* New :func:`.fileOrText` decorator for use in wrapper functions (Martin
Paul McCarthy's avatar
Paul McCarthy committed
930
931
932
933
  Craig).


Changed
Paul McCarthy's avatar
Paul McCarthy committed
934
935
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
936
937
* Various minor changes and enhancements to the FSL function :mod:`.wrappers`
  interfaces (Martin Craig).
Paul McCarthy's avatar
Paul McCarthy committed
938
939
940
941
942
943
944


Fixed
^^^^^

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


Paul McCarthy's avatar
Paul McCarthy committed
947
948
1.12.0 (Sunday October 21st 2018)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966


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
967
968
969
970
971
972
973
974
975
976
977
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
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
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
998
999
1000
1.10.3 (Sunday September 9th 2018)
----------------------------------

For faster browsing, not all history is shown. View entire blame