Skip to content

Commit c89f326

Browse files
authored
Dataset api restructuring (#331)
* WIP add initial documentation * add documentation for dataset API * fix linter errors * fix lint error * update pdoc * implement PR feedback * fix link to class * fix path to class in documentation * update changelog * WIP: remove TiffDataset and TiledTiffDataset * WIP: remove TiffDataset and TiledTiffDataset * cleanup WKMagDataset * rename WKDataset and WKMagDataset * Implement get_view() to be safe * update changelog * fix downsampling * fix bug in add_mag() * fix MagView.for_each_chunk and implement PR feedback * update changelog * update changelog
1 parent 1afe5af commit c89f326

35 files changed

+1645
-3281
lines changed

Changelog.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,20 @@ For upgrade instructions, please check the respective *Breaking Changes* section
1010
[Commits](https://github.com/scalableminds/webknossos-cuber/compare/v0.6.8...HEAD)
1111

1212
### Breaking Changes in Config & CLI
13-
13+
- Refactoring of the dataset API: [#331](https://github.com/scalableminds/webknossos-cuber/pull/331)
14+
- Tiff-support is now dropped (`TiffDataset` and `TiledTiffDataset` are now removed (alongside their corresponding `Layer` and `MagDataset` classes))
15+
- Module names are now lowercase (previously: `wkcuber.api.Dataset`, `wkcuber.api.Layer`, `wkcuber.api.View`, `wkcuber.api.properties.DatasetProperties`, `wkcuber.api.properties.LayerProperties`, `wkcuber.api.properties.ResolutionProperties`)
16+
- Some classes are renamed (`WKDataset` -> `Dataset`, `WKMagDataset` -> `MagView`)
17+
- The "Layer types" (previously `Layer.COLOR` and `Layer.SEGMENTATION`) are now moved into their own class `wkcuber.api.layer.LayerTypes`.
18+
- `View` (in particular `get_view()`) is refactored to be safer (this is also a breaking change).
19+
- The attribute `path_to_mag_dataset` was renamed to `path_to_mag_view`
20+
- Changes for `View.get_view()` (these changes also apply for `MagView.get_view()` (previously `MagDataset.get_view()`)):
21+
- The parameter `relative_offset` was renamed to `offset`.
22+
- The parameter `is_bounded` was dropped (`View`s are now always bounded).
23+
- The order of the parameters `size` and `offset` was changed, so that `offset` is now the first parameter.
24+
- The shorthand `wkcuber.api.dataset.Dataset.get_view()` was removed.
25+
- The flag `--write_tiff` of `convert_nifti` was removed.
26+
1427
### Added
1528

1629
### Changed
-20.9 KB
Binary file not shown.
-20.9 KB
Binary file not shown.
-20.9 KB
Binary file not shown.
-20.9 KB
Binary file not shown.
-20.9 KB
Binary file not shown.
-20.9 KB
Binary file not shown.
-20.9 KB
Binary file not shown.
-20.9 KB
Binary file not shown.
-20.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)