Constructs from component parts.

Parameters:¶

rank: int | None = None¶

Specifies the number of dimensions.

inner_order: Sequence[int] | None = None¶

Permutation specifying the element storage order within the innermost chunks. Corresponds to the JSON ChunkLayout.inner_order member. This must be a permutation of [0, 1, ..., rank-1]. Lexicographic order (i.e. C order/row-major order) is specified as [0, 1, ..., rank-1], while colexicographic order (i.e. Fortran order/column-major order) is specified as [rank-1, ..., 1, 0].

inner_order_soft_constraint: Sequence[int] | None = None¶

Specifies a preferred value for inner_order rather than a hard constraint. Corresponds to the JSON ChunkLayout.inner_order_soft_constraint member. If inner_order is also specified, it takes precedence.

grid_origin: Sequence[int | None] | None = None¶

Hard constraints on the origin of the chunk grid. Corresponds to the JSON ChunkLayout.grid_origin member.

grid_origin_soft_constraint: Sequence[int | None] | None = None¶

Soft constraints on the origin of the chunk grid. Corresponds to the JSON ChunkLayout.grid_origin_soft_constraint member.

chunk: ChunkLayout.Grid | None = None¶

Common constraints on write, read, and codec chunks. Corresponds to the JSON ChunkLayout.chunk member. The shape and elements constraints apply only to write and read chunks, while the aspect_ratio constraints apply to write, read, and codec chunks.

write_chunk: ChunkLayout.Grid | None = None¶

Constraints on write chunks. Corresponds to the JSON ChunkLayout.write_chunk member.

read_chunk: ChunkLayout.Grid | None = None¶

Constraints on read chunks. Corresponds to the JSON ChunkLayout.read_chunk member.

codec_chunk: ChunkLayout.Grid | None = None¶

Constraints on codec chunks. Corresponds to the JSON ChunkLayout.codec_chunk member.

chunk_shape: Sequence[int | None] | None = None¶

Hard constraints on both the write and read chunk shape. Corresponds to the JSON shape member of ChunkLayout.chunk. Equivalent to specifying both write_chunk_shape and read_chunk_shape.

chunk_shape_soft_constraint: Sequence[int | None] | None = None¶

Soft constraints on both the write and read chunk shape. Corresponds to the JSON shape_soft_constraint member of ChunkLayout.chunk. Equivalent to specifying both write_chunk_shape_soft_constraint and read_chunk_shape_soft_constraint.

write_chunk_shape: Sequence[int | None] | None = None¶

Hard constraints on the write chunk shape. Corresponds to the JSON shape member of ChunkLayout.write_chunk.

write_chunk_shape_soft_constraint: Sequence[int | None] | None = None¶

Soft constraints on the write chunk shape. Corresponds to the JSON shape_soft_constraint member of ChunkLayout.write_chunk.

read_chunk_shape: Sequence[int | None] | None = None¶

Hard constraints on the read chunk shape. Corresponds to the JSON shape member of ChunkLayout.read_chunk.

read_chunk_shape_soft_constraint: Sequence[int | None] | None = None¶

Soft constraints on the read chunk shape. Corresponds to the JSON shape_soft_constraint member of ChunkLayout.read_chunk.

codec_chunk_shape: Sequence[int | None] | None = None¶

Soft constraints on the codec chunk shape. Corresponds to the JSON shape member of ChunkLayout.codec_chunk.

codec_chunk_shape_soft_constraint: Sequence[int | None] | None = None¶

Soft constraints on the codec chunk shape. Corresponds to the JSON shape_soft_constraint member of ChunkLayout.codec_chunk.

chunk_aspect_ratio: Sequence[float | None] | None = None¶

Hard constraints on the write, read, and codec chunk aspect ratio. Corresponds to the JSON aspect_ratio member of ChunkLayout.chunk. Equivalent to specifying write_chunk_aspect_ratio, read_chunk_aspect_ratio, and codec_chunk_aspect_ratio.

chunk_aspect_ratio_soft_constraint: Sequence[float | None] | None = None¶

Soft constraints on the write, read, and codec chunk aspect ratio. Corresponds to the aspect_ratio_soft_constraint member of ChunkLayout.chunk. Equivalent to specifying write_chunk_aspect_ratio_soft_constraint, read_chunk_aspect_ratio_soft_constraint, and codec_chunk_aspect_ratio_soft_constraint.

write_chunk_aspect_ratio: Sequence[float | None] | None = None¶

Hard constraints on the write chunk aspect ratio. Corresponds to the JSON aspect_ratio member of ChunkLayout.write_chunk.

write_chunk_aspect_ratio_soft_constraint: Sequence[float | None] | None = None¶

Soft constraints on the write chunk aspect ratio. Corresponds to the JSON aspect_ratio_soft_constraint member of ChunkLayout.write_chunk.

read_chunk_aspect_ratio: Sequence[float | None] | None = None¶

Hard constraints on the read chunk aspect ratio. Corresponds to the JSON aspect_ratio member of ChunkLayout.read_chunk.

read_chunk_aspect_ratio_soft_constraint: Sequence[float | None] | None = None¶

Soft constraints on the read chunk aspect ratio. Corresponds to the JSON aspect_ratio_soft_constraint member of ChunkLayout.read_chunk.

codec_chunk_aspect_ratio: Sequence[float | None] | None = None¶

Soft constraints on the codec chunk aspect ratio. Corresponds to the JSON aspect_ratio member of ChunkLayout.codec_chunk.

codec_chunk_aspect_ratio_soft_constraint: Sequence[float | None] | None = None¶

Soft constraints on the codec chunk aspect ratio. Corresponds to the JSON aspect_ratio_soft_constraint member of ChunkLayout.codec_chunk.

chunk_elements: int | None = None¶

Hard constraints on the target number of elements for write and read chunks. Corresponds to the JSON elements member of ChunkLayout.chunk. Equivalent to specifying both write_chunk_elements and read_chunk_elements.

chunk_elements_soft_constraint: int | None = None¶

Soft constraints on the target number of elements for write and read chunks. Corresponds to the JSON elements_soft_constraint member of ChunkLayout.chunk. Equivalent to specifying both write_chunk_elements_soft_constraint and read_chunk_elements_soft_constraint.

write_chunk_elements: int | None = None¶

Hard constraints on the target number of elements for write chunks. Corresponds to the JSON elements member of ChunkLayout.write_chunk.

write_chunk_elements_soft_constraint: int | None = None¶

Soft constraints on the target number of elements for write chunks. Corresponds to the JSON elements_soft_constraint member of ChunkLayout.write_chunk.

read_chunk_elements: int | None = None¶

Hard constraints on the target number of elements for read chunks. Corresponds to the JSON elements member of ChunkLayout.read_chunk.

read_chunk_elements_soft_constraint: int | None = None¶

Soft constraints on the target number of elements for read chunks. Corresponds to the JSON elements_soft_constraint member of ChunkLayout.read_chunk.

codec_chunk_elements: int | None = None¶

Hard constraints on the target number of elements for codec chunks. Corresponds to the JSON elements member of ChunkLayout.codec_chunk.

codec_chunk_elements_soft_constraint: int | None = None¶

Soft constraints on the target number of elements for codec chunks. Corresponds to the JSON elements_soft_constraint member of ChunkLayout.codec_chunk.

finalize: bool | None = None¶

Validates and converts the layout into a precise chunk layout.

• All dimensions of grid_origin must be specified as hard constraints.

• Any write/read/codec chunk shape soft constraints are cleared.

• Any unspecified dimensions of the read chunk shape are set from the write chunk shape.

• Any write/read/codec chunk aspect_ratio or elements constraints are cleared.