Skip to content

Commit af827a0

Browse files
Add all changes for major release 2.0.0
1 parent dc6dbb8 commit af827a0

1 file changed

Lines changed: 114 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,123 @@
44

55
## 2.0.0
66

7-
### Changed
7+
This major release brings a host of additions and breaking changes across
8+
multiple modules. For detailed information, please refer to the
9+
[API documentation][apidocs].
10+
11+
### Added ✨
12+
13+
#### New functions in `imcflibs.imagej.bioformats`
14+
15+
* `imcflibs.imagej.bioformats.get_reader` gets the reader used for opening a
16+
file, allowing support for multi series files, and gets the highest pyramid
17+
level for infos.
18+
19+
#### New functions in `imcflibs.imagej.bdv`
20+
21+
* `imcflibs.imagej.bdv.read_metadata_from_xml` allows reading metadata back
22+
from the xml of a H5/XML couple.
23+
24+
#### New functions in `imcflibs.imagej.misc`
25+
26+
* `imcflibs.imagej.misc.bytes_to_human_readable` converts size from bytes to a
27+
more readable format.
28+
29+
#### New functions in `imcflibs.imagej.trackmate`
30+
31+
* `imcflibs.imagej.trackmate.set_spotfilter` to set a TrackMate spot filter
32+
with specified filter key and values.
33+
34+
#### New functions in `imcflibs.imagej.pathtools`
35+
36+
* `imcflibs.imagej.pathtools.join_files_with_channel_suffix` to generate lists
37+
of filenames with channel suffixes, facilitating workflows where each
38+
channel is stored in a separate file.
39+
40+
### Changed ♻️
841

942
* Minimum required version for [python-micrometa] increased to `15.2.3`.
1043

44+
#### `imcflibs.imagej.bdv`
45+
46+
* `imcflibs.imagej.bdv.define_dataset_auto` does not split time points by
47+
default any more.
48+
* `imcflibs.imagej.bdv.define_dataset_manual` now supports passing a list of
49+
files (`list_files`) directly, enabling the use of explicit file lists in
50+
"show_list" mode rather than relying solely on file patterns.
51+
* `imcflibs.imagej.bdv.fuse_dataset_bdvp`:
52+
* Fix a bug and expose additional parameters.
53+
* Allow specifying the number of resolution levels, LZW compression, and the
54+
fusion method; update parameter names and documentation for clarity and
55+
flexibility.
56+
* `imcflibs.imagej.bdv.interest_points_registration`: Fix typo and add missing
57+
options.
58+
* `imcflibs.imagej.bdv.resave_as_h5`: use the correct processing options
59+
object and change the ImageJ command to "Resave as HDF5 (local)" for better
60+
accuracy.
61+
62+
#### `imcflibs.imagej.bioformats`
63+
64+
* `imcflibs.imagej.bioformats.import_image` now accepts importing a specified
65+
image region (crop). Also fix a spelling mistake.
66+
67+
#### `imcflibs.imagej.misc`
68+
69+
* `imcflibs.imagej.misc.run_imarisconvert`:
70+
* Now allows to select an output folder.
71+
* Adds pixel calibration to the converted file.
72+
* `imcflibs.imagej.misc.subtract_images` now validates the slice count is equal
73+
for both images.
74+
* `imcflibs.imagej.misc.save_image_with_extension`: fix issue with java path
75+
object.
76+
77+
#### `imcflibs.imagej.objects3d`
78+
79+
* `imcflibs.imagej.objects3d.segment_3d_image`: add option to filter out 3D
80+
objects touching the image borders when creating a label image.
81+
82+
#### `imcflibs.imagej.resultstable`
83+
84+
* `imcflibs.imagej.resultstable.add_results_to_resultstable`:
85+
* Add support for writing values to specific rows in a results table.
86+
* Raise an error when provided values don't match target rows.
87+
* Update docstring description and examples.
88+
89+
#### `imcflibs.imagej.trackmate`
90+
91+
* Improve support for 3D data and fix an issue for diameter of objects to be
92+
found using TrackMate.
93+
94+
#### `imcflibs.omerotools`
95+
96+
* `imcflibs.omerotools.parse_url`: safely handle empty input strings, and strip
97+
the link to ignore trailing white spaces.
98+
99+
#### `imcflibs.pathtools`
100+
101+
* `imcflibs.pathtools.listdir_matching`:
102+
* Enhancement to support recursive directory traversal
103+
* Adds `recursive` parameter to include files from subdirectories
104+
105+
### Removed 🗑️
106+
107+
#### `imcflibs.imagej.objects3d`
108+
109+
* `imcflibs.imagej.objects3d.get_objects_within_intensity` has been removed as
110+
it is now present in the Image3D suite. The method
111+
`mcib3d.geom.Objects3DPopulation.getObjectsWithinIntensityRange` performs
112+
the same function as the removed method from this package.
113+
114+
### Documentation 📝
115+
116+
* Update `README.md` installation instructions to install imcflibs into a
117+
"vanilla" Fiji, including required dependencies.
118+
119+
### Interactive Tests 🧪
120+
121+
* All interactive test files in `tests/interactive-imagej` are now `.py`, so
122+
that they can be dragged directly into a Fiji and run.
123+
11124
## 1.5.0
12125

13126
This release brings a lot of additions, not all changes and functions are

0 commit comments

Comments
 (0)