Streamed Volumes #52
Merged
Streamed Volumes #52
Conversation
This file contains 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
- split NiftiVolume trait to have a separate random access API - `Dim` construct provides nice and efficient volume shape access - volume::streamed module containing volumes read slice by slice - deprecate InMemNiftiVolume::new_from_stream in favor of from_reader - make Nifti object impl more generic, use type alias to retain API - provide nifti object for streamed volumes - add more info to NiftiError::IncompatibleLength
- Improve volume::streamed module documentation - rename methods in NiftiObject away from "stream", "reader" is better
- deprecate old functions - "reader" is more appropriate here, and prevents confusion with async streams
- move Dim to new module volume::shape - add Idx to volume::shape (ndimensional index) - add `indexed` method to streamed volume - document some methods in util
nilgoyette
reviewed
Jun 28, 2019
staged by mistake
- split FromSource trait to have options invariant to source - add "_rank" variants of streamed object construction - move common implementations to generic impl scope - rustfmt
|
Thanks for the initial review, @nilgoyette. A few more changes were pushed just now, some of which reduce redundancy. The subtle differences in each kind of volume make it pretty hard to merge common routines. I haven't benchmarked this yet, but it would be nice to see some measurements on large volumes. The real benefit comes from using much less memory, at the cost of potentially a bit of extra maintenance overhead (plus more allocations if the idiomatic iterator is used instead of the streaming iterator). |
nilgoyette
approved these changes
Jul 2, 2019
- remove redundant commented code - reduce redundancy in GenericNiftiObject::from_reader - rustfmt tests/volume
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 gathers a bunch of additions and changes to the crate so as to provide slice-by-slice reading of volumes. (#44)
A summary of all changes below:
NiftiVolumetrait to have a separate random access API:RandomAccessNiftiVolumeDimandIdxtype definitions for containing a NIfTI-compliant volume shape and index to volume, provides a nicer abstraction than working with the 8-element array directly.volume::streamedmodule contains a volume implementation which reads the voxel data slice by slice.InMemNiftiVolume::new_from_streamand all otherfrom_streamassociated functions in favor offrom_reader, which is more idiomatic and does not conflict with the futures concept of streamGenericNiftiObject.InMemoryNiftiObjectandStreamedNiftiObjectare now aliases to this type.NiftiError::IncompatibleLength