Skip to content

Commit

Permalink
fix: consider only dimensions with size >1 for plane-coordinate (#28)
Browse files Browse the repository at this point in the history
[x] I followed the [How to structure your
PR](https://github.com/ZEISS/pylibczirw/blob/main/CONTRIBUTING.md#creating-a-pr).
[ ] Based on [Commit
Parsing](https://python-semantic-release.readthedocs.io/en/latest/commit-parsing.html):
In case a new **major** release will be created (because the body or
footer begins with 'BREAKING CHANGE:'), I created a new [Jupyter
notebook with a matching
version](https://github.com/ZEISS/pylibczirw/tree/main/doc/jupyter_notebooks).
[ ] Based on [Commit
Parsing](https://python-semantic-release.readthedocs.io/en/latest/commit-parsing.html):
In case a new **minor/patch** release will be created (because PR title
begins with 'feat'/('fix' or 'perf')), I optionally created a new
[Jupyter notebook with a matching
version](https://github.com/ZEISS/pylibczirw/tree/main/doc/jupyter_notebooks).
[ ] In case of API changes, I updated
[API.md](https://github.com/ZEISS/pylibczirw/blob/main/API.md).

Re-write of #16 due to changes in infrastructure.

Fixes #10

---------

Co-authored-by: Soyer, Sebastian <sebastian.soyer@zeiss.com>
Co-authored-by: soyers <soyer.sebastian@gmail.com>
  • Loading branch information
3 people authored Aug 6, 2024
1 parent 3b2ea06 commit 264fcb4
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 16 deletions.
4 changes: 3 additions & 1 deletion pylibCZIrw/czi.py
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,8 @@ def _create_roi(

def _create_default_plane_coords(self) -> Dict[str, int]:
"""Generates a default plane coordinates dictionary with all indexes to 0.
This default plane coordinate contains all dimensions reported being used by
the CZI-document, but includes only dimensions for which the size is >1.
Returns
-------
Expand All @@ -653,7 +655,7 @@ def _create_default_plane_coords(self) -> Dict[str, int]:
return {
dim: 0
for dim, dim_index in self.CZI_DIMS.items()
if self._czi_reader.GetDimensionSize(_pylibCZIrw.DimensionIndex(dim_index)) > 0
if self._czi_reader.GetDimensionSize(_pylibCZIrw.DimensionIndex(dim_index)) > 1
}

def _create_plane_coords(
Expand Down
14 changes: 7 additions & 7 deletions pylibCZIrw/tests/unit/test_czi_reader.py
Original file line number Diff line number Diff line change
Expand Up @@ -444,14 +444,14 @@ def test_create_roi_raises_error_on_incorrect_scene() -> None:
@pytest.mark.parametrize(
"GetDimensionSize, expected",
[
(dimension_sizes_test1, {"C": 0}),
(dimension_sizes_test1, {}),
(
dimension_sizes_test2,
{"C": 0, "I": 0, "R": 0, "V": 0},
{"C": 0, "R": 0, "V": 0},
),
(
dimension_sizes_test3,
{"Z": 0, "C": 0, "T": 0, "R": 0, "I": 0, "H": 0, "V": 0, "B": 0},
{"Z": 0, "C": 0, "T": 0, "R": 0, "I": 0, "V": 0, "B": 0},
),
],
)
Expand All @@ -469,17 +469,17 @@ def test_create_default_plane_coords(
@pytest.mark.parametrize(
"plane, GetDimensionSize, expected",
[
(None, dimension_sizes_test1, {"C": 0}),
({"C": 1, "Z": 3, "T": 4}, dimension_sizes_test1, {"C": 1}),
(None, dimension_sizes_test1, {}),
({"C": 1, "Z": 3, "T": 4}, dimension_sizes_test1, {}),
(
{"C": 5, "Z": 3, "T": 4, "B": 12},
dimension_sizes_test2,
{"C": 5, "I": 0, "R": 0, "V": 0},
{"C": 5, "R": 0, "V": 0},
),
(
None,
dimension_sizes_test3,
{"Z": 0, "C": 0, "T": 0, "R": 0, "I": 0, "H": 0, "V": 0, "B": 0},
{"Z": 0, "C": 0, "T": 0, "R": 0, "I": 0, "V": 0, "B": 0},
),
],
)
Expand Down
8 changes: 0 additions & 8 deletions requirements_test.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Used for testing
mypy
types-all
pylint==2.17.7
pylint-runner==0.6.0
flake8
flake8-docstrings
flake8-bugbear
bandit
black
check-python-versions
tox==3.27.1
tox-current-env
Expand Down

0 comments on commit 264fcb4

Please sign in to comment.