Skip to content

Commit 9417a80

Browse files
committed
DOC: Update changelog for upcoming 4.0 release
1 parent 1312493 commit 9417a80

File tree

1 file changed

+84
-2
lines changed

1 file changed

+84
-2
lines changed

Changelog

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,90 @@ Eric Larson (EL), Demian Wassermann, Stephan Gerhard and Ross Markello (RM).
2525

2626
References like "pr/298" refer to github pull request numbers.
2727

28+
4.0.0 (To be determined)
29+
========================
30+
31+
New feature release in the 4.0.x series.
32+
33+
New features
34+
------------
35+
* Add ``'mask'``, ``'compat'`` and ``'smallest'`` dtype aliases to NIfTI images
36+
to allow for dtype specifications that can depend on the contents of the data.
37+
``'mask'`` is a synonym for ``uint8``. ``'compat'`` will find the nearest
38+
Analyze-compatible (therefore widely supported) dtype that will not truncate
39+
the data. ``'smallest'`` attempts to find the smallest integer dtype that will
40+
contain the data. (pr/1096) (CM, reviewed by Chris Rorden and Josh Teves)
41+
* Add ``dtype`` arguments to ``Cifti2Image`` (pr/1111) (CM)
42+
* Allow dtypes to be passed to Analyze-like images at ``__init__()`` and
43+
``to_filename()`` to provide better control over output images. (pr/1082)
44+
(CM, following discussions with Chris Rorden, Josh Teves, Jerome Dockes, and MB)
45+
* Allow compressed GIFTI images (MB, reviewed by CM)
46+
* Add zstd compression support (pr/1005) (Andrew Van, reviewed by CM)
47+
* Support ``ExternalFileBinary`` GIFTI data arrays (PM, reviewed by CM)
48+
49+
Enhancements
50+
------------
51+
* Document ``InTemporaryDirectory`` as non-thread-safe (pr/1103) (Jacob Roberts,
52+
reviewed by MB)
53+
* Unify Caret-XML-style metadata structure (GiftiMetaData, Cifti2MetaData)
54+
as dict-like (pr/1091) (CM, reviewed by Josh Teves and Hao-Ting Wang)
55+
* Add ``__repr__`` methods to GIFTI objects (pr/1092) (CM,
56+
reviewed by Josh Teves and Hao-Ting Wang)
57+
* Create gzip header deterministically by default (pr/1024) (CM, reviewed by YOH)
58+
* Provide clear error message when files with zip extensions don't match
59+
file contents (pr/1013) (Jérôme Dockès, reviewed by CM)
60+
61+
Bug fixes
62+
---------
63+
* Re-import externals/netcdf.py from scipy to resolve numpy API change (pr/1110)
64+
(CM)
65+
* Resize ArraySequence.data without helper function to avoid reference increment
66+
(pr/1093) (MC, reviewed by CM)
67+
68+
Maintenance
69+
-----------
70+
* Update submodule URLs to use https over git protocol (pr/1097) (CM)
71+
* Published BIAP 9: CoordinateImage API (pr/1084) (CM)
72+
* Drop uses of deprecated ``distutils`` (pr/1073) (CM, reviewed by MB)
73+
* Suppress LGTM false alarm "Clear-text logging of sensitive information"
74+
(pr/1052) (Dimitri Papadopoulos, reviewed by CM)
75+
* Test on Python 3.10 (pr/1047) (CM)
76+
* Fix typos found by codespell (pr/1040, pr/1044)
77+
(Dimitri Papadopoulos, reviewed by CM)
78+
* Run stable tests weekly, pre-release tests nightly (pr/1025) (CM)
79+
* Documentation updates to establish/clarify governance and decision
80+
making (pr/1019, pr/1020, pr/1022, pr/1018, pr/1017, pr/1016) (MB and CM)
81+
82+
API changes and deprecations
83+
----------------------------
84+
* Writing NIfTIs with 64-bit integer dtypes is getting harder.
85+
Passing ``(u)int64`` arrays to ``Nifti1Image`` and subclasses will warn unless
86+
a ``header`` or ``dtype`` option is passed; in the future this will become an
87+
error.
88+
Additionally, passing ``int`` or ``'int'`` to ``set_data_dtype()`` now raises
89+
an error, requiring an explicit numpy dtype to make 64-bit integer images.
90+
(pr/1082) (CM, following discussions with Chris Rorden, Josh Teves, Jerome Dockes,
91+
and MB)
92+
* Drop support for Python 3.6, Numpy < 1.17 (pr/1079) (CM)
93+
* Fully removed the following APIs, which have raised errors on use
94+
since 3.0 (pr/980) (CM, reviewed by Jonathan Daniel)
95+
* ``nibabel.trackvis``
96+
* ``nibabel.volumeutils.calculate_scale``
97+
* ``nibabel.volumeutils.can_cast``
98+
* ``nibabel.volumeutils.scale_min_max``
99+
* ``nibabel.dataobj_images.DataobjImage.get_shape``
100+
* ``nibabel.minc1.MincImage`` (use ``Minc1Image``)
101+
* ``nibabel.minc1.MincFile`` (use ``Minc1File``)
102+
* ``nibabel.filebasedimages.FileBasedImage.from_files``
103+
* ``nibabel.filebasedimages.FileBasedImage.filespec_to_files``
104+
* ``nibabel.filebasedimages.FileBasedImage.to_filespec``
105+
* ``nibabel.filebasedimages.FileBasedImage.to_files``
106+
* ``nibabel.arrayproxy.ArrayProxy.header``
107+
* ``keep_file_open=="auto"`` parameter to load method (now must be boolean)
108+
109+
28110
3.2.2 (Monday 7 February 2022)
29-
=================================
111+
==============================
30112

31113
Bug fix release in the 3.2.x series.
32114

@@ -557,7 +639,7 @@ Maintenance
557639
* Use SSH address to use key-based auth (pr/587) (CM, reviewed by MB)
558640
* Fix doctests for numpy 1.14 array printing (pr/591) (MB, reviewed by CM)
559641
* Refactor for pydicom 1.0 API changes (pr/599) (MB, reviewed by CM)
560-
* Increase test coverage, remove unreachable code (pr/602) (CM, reviewed by
642+
* Increase test coverage, remove unreachable code (pr/602) (CM, reviewed by
561643
Yaroslav Halchenko, MB)
562644
* Move ``nib-ls`` and other programs to a new cmdline module (pr/601, pr/615)
563645
(Chris Cheng, reviewed by MB, Yaroslav Halchenko)

0 commit comments

Comments
 (0)