Dataset dimension/axis label renaming #322
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds support for dimension renaming with net.imagej.Dataset objects. The _rename_dataset_dims() function matches the _rename_xarray_dims() function in that it *only* renames the dimensions of the input data. It does not transpose the data array or modify the coordinates/calibration. Users should use transpose and permute with their respective xarray and dataset objects. The _rename_dataset_dims() function gets the axis type from new dim order sequencs and creates a new axis with the old scale and origin values, preserving the axis coordinates. This implementation only supports DefaultLinearAxis.
Instead of creating new DefaultLinearAxis or EnumeratedAxis, simply set the axis type on the existing axes. Both DefaultLinearAxis and EnumeratedAxis both inherit net.imagej.TypedAxis.
This commit makes updates the dataset to dataset conversion tests with new and expected dimension label outcomes.
This commit adds a new section to the Working-with-Images notebook demonstrating how to rename the dimension labels on both Python and Java images. Note that I added this section as 6.11 and incremented all following heading numbers by 1.
gselzer
approved these changes
Mar 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR address issue #304 by adding support for dimension label renaming on
net.imagej.Datasetobjects via theto_dataset()method (with dim order hints). Below is a list of what this PR brings:net.imagej.DatasetDefaultLinearAxisandEnumeratedAxistype.Datasetconversion tests to test dim renaming.06-Working-with-images, 6.11, demonstrating how to use the renaming features.