-
Notifications
You must be signed in to change notification settings - Fork 10
Rectilinear (variable-length) chunk grid #25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
d-v-b
wants to merge
8
commits into
zarr-developers:main
Choose a base branch
from
d-v-b:feat/rectilinear-chunk-grid
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+231
−0
Open
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
892e761
initial commit of readme
d-v-b 2c56410
apply feedback from code review
d-v-b 84831bc
expand prior work section
d-v-b bee5f0a
punctuation
d-v-b a9ebbf2
restore single-integer chunk edge length declaration
d-v-b 945853a
fix prose and logic
d-v-b 99ba310
add jsonschema
d-v-b f17e76c
rename variables in schema
d-v-b File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # Rectilinear chunk grid | ||
|
|
||
| ## Metadata | ||
|
|
||
| | field | type | required | | ||
| | - | - | - | | ||
| | `"name"` | Literal `"rectilinear"` | yes | | ||
| | `"configuration"` | [#configuration][] | yes | | ||
|
|
||
| ### Configuration | ||
|
|
||
| | field | type | required | notes | | ||
| | - | - | - | - | | ||
| | `"kind"` | Literal `"inline"` | yes | | | ||
| | `"chunk_shapes"` | array[[Chunk edge lengths](#chunk-edge-lengths)] | | ||
|
|
||
| #### Chunk edge lengths | ||
|
|
||
| The edge lengths of the chunks along an array axis `A` are represented by an array that can contain two types of elements: | ||
| - an integer that explicitly denotes denotes an edge length | ||
d-v-b marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - an array that denotes a [run-length encoded](#run-length-encoding) sequence of integers, each of which denotes an edge length | ||
|
|
||
| The sum of the edge lengths MUST match the length of the array along the axis `A`. | ||
|
|
||
| #### Run-length encoding | ||
|
|
||
| This specificiation defines a JSON representation for run-length encoded sequences. | ||
|
|
||
| A run-length encoded sequence of `N` repetitions of some value `T` is denoted by the length-2 JSON array `[T, N]`. | ||
|
|
||
| For example, the sequence `[1, 1, 1, 1, 1]` becomes `[1, 5]` after applying this run-length encoding. | ||
|
|
||
| ## Examples | ||
|
|
||
| This example demonstrates 5 different ways of specifying a rectilinear chunk grid for an array with shape `(6, 6, 6, 6, 6)`. | ||
|
|
||
| ```javascript | ||
| { | ||
| ... | ||
| "shape": [6, 6, 6, 6, 6], | ||
| "chunk_grid": { | ||
| "name": "rectilinear", | ||
| "configuration": { | ||
| "kind": "inline", | ||
| "chunk_shapes": [ | ||
| [[2, 3]], // expands to [2, 2, 2] | ||
| [[1, 6]], // expands to [1, 1, 1, 1, 1, 1] | ||
| [1, [2, 1], 3], // expands to [1, 2, 3] | ||
| [[1, 3], 3], // expands to [1, 1, 1, 3] | ||
| [6], // expands to [6] | ||
d-v-b marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ] | ||
| } | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
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.
Uh oh!
There was an error while loading. Please reload this page.