Revise how the Blosc codec is specified #225
Merged
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
|
cc @jakirkham |
jstriebel
reviewed
Mar 31, 2023
Closed
The `shuffle` mode is now specified more clearly as `null` (0 in Zarr v2), `"bit"` (2 in Zarr v2), or `"byte"` (1 in Zarr v2). Using these constants rather than numbers makes it much easier to know what shuffle mode will be using from manual inspection of the metadata. When shuffling is enabled, the `typesize` must now be specified explicitly in the metadata, rather than determined implicitly from the input data. This allows Blosc to function as a pure "bytes -> bytes" codec rather than an "array -> bytes" codec. The special `shuffle` value of `-1`, which indicated to choose automatically between bit-wise or byte-wise shuffling depending on the typesize value, is not supported in the metadata.
|
I updated the shuffle constants to "noshuffle", "shuffle" and "bitshuffle" to match the blosc C API. Per discussions in the ZEP1 review and the recent ZEP meeting, I have retained typesize. |
jstriebel
reviewed
May 3, 2023
Co-authored-by: Jonathan Striebel <jstriebel@users.noreply.github.com>
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.
The
shufflemode is now specified more clearly asnull(0 in Zarr v2),"bit"(2 in Zarr v2), or"byte"(1 in Zarr v2). Using these constants rather than numbers makes it much easier to know what shuffle mode will be using from manual inspection of the metadata.When shuffling is enabled, the
typesizemust now be specified explicitly in the metadata, rather than determined implicitly from the input data. This allows Blosc to function as a pure "bytes -> bytes" codec rather than an "array -> bytes" codec.The special
shufflevalue of-1, which indicated to choose automatically between bit-wise or byte-wise shuffling depending on the typesize value, is not supported in the metadata.