org.janelia.saalfeldlab.n5.zarr.v3

Class ZarrV3DatasetAttributes.Builder

java.lang.Object

org.janelia.saalfeldlab.n5.DatasetAttributes.Builder

org.janelia.saalfeldlab.n5.zarr.v3.ZarrV3DatasetAttributes.Builder

Enclosing class:

ZarrV3DatasetAttributes

public static class ZarrV3DatasetAttributes.Builder
extends org.janelia.saalfeldlab.n5.DatasetAttributes.Builder

Builder for constructing ZarrV3DatasetAttributes instances.

Required parameters are shape and dataType, which must be provided via the constructor. All other parameters have sensible defaults.

Example usage:

 ZarrV3DatasetAttributes attrs = new ZarrV3DatasetAttributes.Builder(
         new long[]{100, 100, 100}, DataType.FLOAT32)
     .blockSize(new int[]{32, 32, 32})
     .fillValue("0.0")
     .compression(new GzipCompression())
     .build();
 

Constructor Summary

Constructors

Constructor and Description
Builder(org.janelia.saalfeldlab.n5.DatasetAttributes attributes)
Builder(long[] dimensions, org.janelia.saalfeldlab.n5.DataType dataType) Creates a new builder with the required parameters.
Builder(long[] dimensions, ZarrV3DataType dataType) Creates a new builder with the required parameters.

Method Summary

Modifier and Type	Method and Description
ZarrV3DatasetAttributes.Builder	blockCodecInfo(org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo) Sets the block codec info.
ZarrV3DatasetAttributes.Builder	blockSize(int[] blockSize) Sets the chunk shape (block size).
ZarrV3DatasetAttributes	build() Builds the ZarrV3DatasetAttributes instance.
ZarrV3DatasetAttributes.Builder	chunkKeyEncoding(DefaultChunkKeyEncoding chunkKeyEncoding) Sets the chunk key encoding.
ZarrV3DatasetAttributes.Builder	chunkSize(int[] chunkSize) Sets the chunk shape for sharded arrays.
ZarrV3DatasetAttributes.Builder	compression(org.janelia.saalfeldlab.n5.Compression compression) Sets the compression codec.
ZarrV3DatasetAttributes.Builder	dataCodecInfos(org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecInfos) Sets the data codec infos (e.g., compression).
ZarrV3DatasetAttributes.Builder	datasetCodecInfos(org.janelia.saalfeldlab.n5.codec.DatasetCodecInfo... datasetCodecInfos) Sets the dataset codec infos.
ZarrV3DatasetAttributes.Builder	dimensionNames(String[] dimensionNames) Sets the dimension names.
ZarrV3DatasetAttributes.Builder	dimensionSeparator(String dimensionSeparator) Sets the dimension separator used in chunk keys.
ZarrV3DatasetAttributes.Builder	fillValue(String fillValue) Sets the fill value for uninitialized chunks.
ZarrV3DatasetAttributes.Builder	shardIndexDataCodecInfos(org.janelia.saalfeldlab.n5.codec.DataCodecInfo... shardIndexDataCodecInfos) Sets the data codec infos for the shard index;

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(long[] dimensions,
               org.janelia.saalfeldlab.n5.DataType dataType)

Creates a new builder with the required parameters.

Parameters:

dimensions - the dimensions of the array

dataType - the N5 data type

Builder

public Builder(long[] dimensions,
               ZarrV3DataType dataType)

Creates a new builder with the required parameters.

Parameters:

dimensions - the dimensions of the array

dataType - the Zarr v3 data type

Builder

public Builder(org.janelia.saalfeldlab.n5.DatasetAttributes attributes)

Method Detail

blockSize

public ZarrV3DatasetAttributes.Builder blockSize(int[] blockSize)

Sets the chunk shape (block size).

Overrides:

blockSize in class org.janelia.saalfeldlab.n5.DatasetAttributes.Builder

Parameters:

blockSize - the chunk dimensions

Returns:

this builder

chunkSize

public ZarrV3DatasetAttributes.Builder chunkSize(int[] chunkSize)

Sets the chunk shape for sharded arrays. When set, chunks will be grouped into shards of this size.

Parameters:

chunkSize - the shard dimensions

Returns:

this builder

fillValue

public ZarrV3DatasetAttributes.Builder fillValue(String fillValue)

Sets the fill value for uninitialized chunks.

Parameters:

fillValue - the fill value as a string

Returns:

this builder

dimensionNames

public ZarrV3DatasetAttributes.Builder dimensionNames(String[] dimensionNames)

Sets the dimension names.

Parameters:

dimensionNames - the names for each dimension

Returns:

this builder

dimensionSeparator

public ZarrV3DatasetAttributes.Builder dimensionSeparator(String dimensionSeparator)

Sets the dimension separator used in chunk keys.

Parameters:

dimensionSeparator - the separator (must be "/" or ".")

Returns:

this builder

chunkKeyEncoding

public ZarrV3DatasetAttributes.Builder chunkKeyEncoding(DefaultChunkKeyEncoding chunkKeyEncoding)

Sets the chunk key encoding.

Parameters:

chunkKeyEncoding - the chunk key encoding

Returns:

this builder

compression

public ZarrV3DatasetAttributes.Builder compression(org.janelia.saalfeldlab.n5.Compression compression)

Sets the compression codec.

Overrides:

compression in class org.janelia.saalfeldlab.n5.DatasetAttributes.Builder

Parameters:

compression - the compression to use

Returns:

this builder

blockCodecInfo

public ZarrV3DatasetAttributes.Builder blockCodecInfo(org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo)

Sets the block codec info.

Parameters:

blockCodecInfo - the block codec

Returns:

this builder

datasetCodecInfos

public ZarrV3DatasetAttributes.Builder datasetCodecInfos(org.janelia.saalfeldlab.n5.codec.DatasetCodecInfo... datasetCodecInfos)

Sets the dataset codec infos.

Parameters:

datasetCodecInfos - the dataset codecs

Returns:

this builder

dataCodecInfos

public ZarrV3DatasetAttributes.Builder dataCodecInfos(org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecInfos)

Sets the data codec infos (e.g., compression).

Parameters:

dataCodecInfos - the data codecs

Returns:

this builder

shardIndexDataCodecInfos

public ZarrV3DatasetAttributes.Builder shardIndexDataCodecInfos(org.janelia.saalfeldlab.n5.codec.DataCodecInfo... shardIndexDataCodecInfos)

Sets the data codec infos for the shard index;

Parameters:

shardIndexDataCodecInfos - the data codecs

Returns:

this builder

build

public ZarrV3DatasetAttributes build()

Builds the ZarrV3DatasetAttributes instance.

Overrides:

build in class org.janelia.saalfeldlab.n5.DatasetAttributes.Builder

Returns:

the constructed dataset attributes