org.janelia.saalfeldlab.n5.zarr.v3

Class ZarrV3DatasetAttributes

java.lang.Object

org.janelia.saalfeldlab.n5.DatasetAttributes

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

All Implemented Interfaces:

Serializable, ZarrV3Node

public class ZarrV3DatasetAttributes
extends org.janelia.saalfeldlab.n5.DatasetAttributes
implements ZarrV3Node

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZarrV3DatasetAttributes.Builder Builder for constructing ZarrV3DatasetAttributes instances.
static class	ZarrV3DatasetAttributes.ByteOrderAdapter
static class	ZarrV3DatasetAttributes.JsonAdapter

Nested classes/interfaces inherited from class org.janelia.saalfeldlab.n5.DatasetAttributes

org.janelia.saalfeldlab.n5.DatasetAttributes.DatasetAttributesAdapter

Nested classes/interfaces inherited from interface org.janelia.saalfeldlab.n5.zarr.v3.ZarrV3Node

ZarrV3Node.NodeType

Field Summary

Fields

Modifier and Type	Field and Description
static ZarrV3DatasetAttributes.ByteOrderAdapter	byteOrderAdapter
static String	CHUNK_GRID_KEY
static String	CHUNK_KEY_ENCODING_KEY
protected ChunkAttributes	chunkAttributes
static String	CODECS_KEY
static String	DATA_TYPE_KEY
static String	DIMENSION_NAMES_KEY
protected String[]	dimensionNames
static String	FILL_VALUE_KEY
protected byte[]	fillBytes
protected com.google.gson.JsonElement	fillValue
static int	FORMAT
static ZarrV3DatasetAttributes.JsonAdapter	jsonAdapter
static String[]	REQUIRED_KEYS
static String	SHAPE_KEY
protected ZarrV3DataType	zarrDataType

Fields inherited from class org.janelia.saalfeldlab.n5.DatasetAttributes

BLOCK_SIZE_KEY, CODEC_KEY, COMPRESSION_KEY, compressionTypeKey, DIMENSIONS_KEY, N5_DATASET_ATTRIBUTES, SHARD_SIZE_KEY

Fields inherited from interface org.janelia.saalfeldlab.n5.zarr.v3.ZarrV3Node

ATTRIBUTES_KEY, NODE_TYPE_KEY, ZARR_FORMAT_KEY

Constructor Summary

Constructors

Constructor and Description
ZarrV3DatasetAttributes(long[] dimensions, ChunkAttributes chunkAttributes, ZarrV3DataType zarrDataType, String fillValue, String[] dimensionNames, org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo, org.janelia.saalfeldlab.n5.codec.DatasetCodecInfo[] datasetCodecInfos, org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecInfos)
ZarrV3DatasetAttributes(long[] dimensions, int[] blockSize, org.janelia.saalfeldlab.n5.DataType dataType, org.janelia.saalfeldlab.n5.Compression compression)
ZarrV3DatasetAttributes(long[] dimensions, int[] blockSize, org.janelia.saalfeldlab.n5.DataType dataType, String fillValue, String[] dimensionNames, org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecs)
ZarrV3DatasetAttributes(long[] dimensions, int[] shardSize, int[] blockSize, org.janelia.saalfeldlab.n5.DataType dataType, org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecs)
ZarrV3DatasetAttributes(long[] dimensions, int[] shardSize, int[] blockSize, org.janelia.saalfeldlab.n5.DataType dataType, String[] dimensionNames, org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecs)
ZarrV3DatasetAttributes(long[] dimensions, int[] shardSize, int[] blockSize, org.janelia.saalfeldlab.n5.DataType dataType, String fillValue, String[] dimensionNames, org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecs)
ZarrV3DatasetAttributes(long[] dimensions, int[] chunkShape, ZarrV3DataType dataType, String fillValue, String[] dimensionNames, DefaultChunkKeyEncoding chunkKeyEncoding, org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo, org.janelia.saalfeldlab.n5.codec.DatasetCodecInfo[] datasetCodecInfos, org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecInfos)
ZarrV3DatasetAttributes(long[] dimensions, int[] chunkShape, ZarrV3DataType dataType, String fillValue, String[] dimensionNames, String dimensionSeparator, org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo, org.janelia.saalfeldlab.n5.codec.DatasetCodecInfo[] datasetCodecInfos, org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecInfos)

Method Summary

Modifier and Type	Method and Description
static ZarrV3DatasetAttributes.Builder	builder(org.janelia.saalfeldlab.n5.DatasetAttributes attributes)
static ZarrV3DatasetAttributes.Builder	builder(long[] dimensions, org.janelia.saalfeldlab.n5.DataType dataType)
protected static int[]	deepestChunkShape(org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo)
protected org.janelia.saalfeldlab.n5.codec.BlockCodecInfo	defaultBlockCodecInfo()
protected static ChunkAttributes	defaultChunkAttributes(int[] blockSize)
protected static int[]	defaultChunkShape(long[] dimensions)
protected static String[]	defaultDimensionNames(int nd)
protected static org.janelia.saalfeldlab.n5.codec.BlockCodecInfo	defaultShardCodecInfo(int[] blockSize, org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] dataCodecInfos)
protected static org.janelia.saalfeldlab.n5.codec.BlockCodecInfo	defaultShardCodecInfo(int[] blockSize, org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] dataCodecInfos, org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] shardIndexDataCodecInfos)
static ZarrV3DatasetAttributes	from(org.janelia.saalfeldlab.n5.DatasetAttributes datasetAttributes, String dimensionSeparator, String fillValue)
ChunkAttributes	getChunkAttributes()
org.janelia.saalfeldlab.n5.Compression	getCompression() Deprecated.
String[]	getDimensionNames()
ZarrV3DataType	getDType()
byte[]	getFillBytes()
String	getFillValue()
ZarrV3Node.NodeType	getType()
int	getZarrFormat()
String	relativeBlockPath(long... gridPosition)
protected static org.janelia.saalfeldlab.n5.codec.DataCodecInfo[]	toZarrV3(org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] dataCodecInfos)

Methods inherited from class org.janelia.saalfeldlab.n5.DatasetAttributes

asMap, defaultBlockSize, getBlockCodecInfo, getBlockSize, getChunkSize, getDataCodecInfos, getDatasetAccess, getDatasetCodecInfos, getDataType, getDefaultValue, getDimensions, getJsonAdapter, getNestedBlockGrid, getNumDimensions, isSharded

Methods inherited from class java.lang.Object

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

Field Detail

SHAPE_KEY

public static final String SHAPE_KEY

See Also:

Constant Field Values

FILL_VALUE_KEY

public static final String FILL_VALUE_KEY

See Also:

Constant Field Values

DATA_TYPE_KEY

public static final String DATA_TYPE_KEY

See Also:

Constant Field Values

CHUNK_GRID_KEY

public static final String CHUNK_GRID_KEY

See Also:

Constant Field Values

CHUNK_KEY_ENCODING_KEY

public static final String CHUNK_KEY_ENCODING_KEY

See Also:

Constant Field Values

DIMENSION_NAMES_KEY

public static final String DIMENSION_NAMES_KEY

See Also:

Constant Field Values

CODECS_KEY

public static final String CODECS_KEY

See Also:

Constant Field Values

FORMAT

public static final int FORMAT

See Also:

Constant Field Values

REQUIRED_KEYS

public static final String[] REQUIRED_KEYS

chunkAttributes

protected final ChunkAttributes chunkAttributes

zarrDataType

protected final ZarrV3DataType zarrDataType

fillValue

protected final com.google.gson.JsonElement fillValue

dimensionNames

protected final String[] dimensionNames

fillBytes

protected final transient byte[] fillBytes

jsonAdapter

public static ZarrV3DatasetAttributes.JsonAdapter jsonAdapter

byteOrderAdapter

public static final ZarrV3DatasetAttributes.ByteOrderAdapter byteOrderAdapter

Constructor Detail

ZarrV3DatasetAttributes

public ZarrV3DatasetAttributes(long[] dimensions,
                               int[] blockSize,
                               org.janelia.saalfeldlab.n5.DataType dataType,
                               org.janelia.saalfeldlab.n5.Compression compression)

ZarrV3DatasetAttributes

public ZarrV3DatasetAttributes(long[] dimensions,
                               int[] shardSize,
                               int[] blockSize,
                               org.janelia.saalfeldlab.n5.DataType dataType,
                               org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecs)

ZarrV3DatasetAttributes

public ZarrV3DatasetAttributes(long[] dimensions,
                               int[] shardSize,
                               int[] blockSize,
                               org.janelia.saalfeldlab.n5.DataType dataType,
                               String[] dimensionNames,
                               org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecs)

ZarrV3DatasetAttributes

public ZarrV3DatasetAttributes(long[] dimensions,
                               int[] blockSize,
                               org.janelia.saalfeldlab.n5.DataType dataType,
                               String fillValue,
                               String[] dimensionNames,
                               org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecs)

ZarrV3DatasetAttributes

public ZarrV3DatasetAttributes(long[] dimensions,
                               int[] shardSize,
                               int[] blockSize,
                               org.janelia.saalfeldlab.n5.DataType dataType,
                               String fillValue,
                               String[] dimensionNames,
                               org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecs)

ZarrV3DatasetAttributes

public ZarrV3DatasetAttributes(long[] dimensions,
                               ChunkAttributes chunkAttributes,
                               ZarrV3DataType zarrDataType,
                               String fillValue,
                               String[] dimensionNames,
                               org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo,
                               org.janelia.saalfeldlab.n5.codec.DatasetCodecInfo[] datasetCodecInfos,
                               org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecInfos)

ZarrV3DatasetAttributes

public ZarrV3DatasetAttributes(long[] dimensions,
                               int[] chunkShape,
                               ZarrV3DataType dataType,
                               String fillValue,
                               String[] dimensionNames,
                               DefaultChunkKeyEncoding chunkKeyEncoding,
                               org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo,
                               org.janelia.saalfeldlab.n5.codec.DatasetCodecInfo[] datasetCodecInfos,
                               org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecInfos)

ZarrV3DatasetAttributes

public ZarrV3DatasetAttributes(long[] dimensions,
                               int[] chunkShape,
                               ZarrV3DataType dataType,
                               String fillValue,
                               String[] dimensionNames,
                               String dimensionSeparator,
                               org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo,
                               org.janelia.saalfeldlab.n5.codec.DatasetCodecInfo[] datasetCodecInfos,
                               org.janelia.saalfeldlab.n5.codec.DataCodecInfo... dataCodecInfos)

Method Detail

defaultBlockCodecInfo

protected org.janelia.saalfeldlab.n5.codec.BlockCodecInfo defaultBlockCodecInfo()

Overrides:

defaultBlockCodecInfo in class org.janelia.saalfeldlab.n5.DatasetAttributes

defaultShardCodecInfo

protected static org.janelia.saalfeldlab.n5.codec.BlockCodecInfo defaultShardCodecInfo(int[] blockSize,
                                                                                       org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] dataCodecInfos,
                                                                                       org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] shardIndexDataCodecInfos)

defaultShardCodecInfo

protected static org.janelia.saalfeldlab.n5.codec.BlockCodecInfo defaultShardCodecInfo(int[] blockSize,
                                                                                       org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] dataCodecInfos)

toZarrV3

protected static org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] toZarrV3(org.janelia.saalfeldlab.n5.codec.DataCodecInfo[] dataCodecInfos)

defaultDimensionNames

protected static String[] defaultDimensionNames(int nd)

defaultChunkAttributes

protected static ChunkAttributes defaultChunkAttributes(int[] blockSize)

defaultChunkShape

protected static int[] defaultChunkShape(long[] dimensions)

deepestChunkShape

protected static int[] deepestChunkShape(org.janelia.saalfeldlab.n5.codec.BlockCodecInfo blockCodecInfo)

from

public static ZarrV3DatasetAttributes from(org.janelia.saalfeldlab.n5.DatasetAttributes datasetAttributes,
                                           String dimensionSeparator,
                                           String fillValue)

relativeBlockPath

public String relativeBlockPath(long... gridPosition)

Overrides:

relativeBlockPath in class org.janelia.saalfeldlab.n5.DatasetAttributes

getCompression

@Deprecated
public org.janelia.saalfeldlab.n5.Compression getCompression()

Deprecated.

Overrides:

getCompression in class org.janelia.saalfeldlab.n5.DatasetAttributes

getChunkAttributes

public ChunkAttributes getChunkAttributes()

getDType

public ZarrV3DataType getDType()

getZarrFormat

public int getZarrFormat()

getFillValue

public String getFillValue()

getDimensionNames

public String[] getDimensionNames()

getFillBytes

public byte[] getFillBytes()

getType

public ZarrV3Node.NodeType getType()

Specified by:

getType in interface ZarrV3Node

builder

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

builder

public static ZarrV3DatasetAttributes.Builder builder(org.janelia.saalfeldlab.n5.DatasetAttributes attributes)