org.janelia.saalfeldlab.n5

Class DatasetAttributes

java.lang.Object

org.janelia.saalfeldlab.n5.DatasetAttributes

All Implemented Interfaces:

Serializable

public class DatasetAttributes
extends Object
implements Serializable

Mandatory dataset attributes:

1. long[] : dimensions
2. int[] : blockSize
3. DataType : dataType
4. CodecInfo... : encode/decode routines

Author:

Stephan Saalfeld

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatasetAttributes.Builder
static class	DatasetAttributes.DatasetAttributesAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOCK_SIZE_KEY
static String	CODEC_KEY
static String	COMPRESSION_KEY
protected static String	compressionTypeKey
static String	DATA_TYPE_KEY
static String	DIMENSIONS_KEY
static String[]	N5_DATASET_ATTRIBUTES
static String	SHARD_SIZE_KEY

Constructor Summary

Constructors

Constructor and Description
DatasetAttributes(long[] dimensions, int[] blockSize, DataType dataType) Constructs a DatasetAttributes instance with specified dimensions, block size, data type, and default codecs
DatasetAttributes(long[] dimensions, int[] outerBlockSize, DataType dataType, BlockCodecInfo blockCodecInfo, DataCodecInfo... dataCodecInfos)
DatasetAttributes(long[] dimensions, int[] outerBlockSize, DataType dataType, BlockCodecInfo blockCodecInfo, DatasetCodecInfo[] datasetCodecInfos, DataCodecInfo... dataCodecInfos)
DatasetAttributes(long[] dimensions, int[] blockSize, DataType dataType, DataCodecInfo... dataCodecInfos) Constructs a DatasetAttributes instance with specified dimensions, block size, data type, and single compressor with default codec.
DatasetAttributes(long[] dimensions, int[] blockSize, DataType dataType, com.google.gson.JsonElement defaultValue, BlockCodecInfo blockCodecInfo, DatasetCodecInfo[] datasetCodecInfos, DataCodecInfo... dataCodecInfos)

Method Summary

Modifier and Type	Method and Description
HashMap<String,Object>	asMap()
static DatasetAttributes.Builder	builder(DatasetAttributes attributes)
static DatasetAttributes.Builder	builder(long[] dimensions, DataType dataType)
protected BlockCodecInfo	defaultBlockCodecInfo()
protected static int[]	defaultBlockSize(long[] dimensions)
BlockCodecInfo	getBlockCodecInfo()
int[]	getBlockSize()
int[]	getChunkSize()
Compression	getCompression() Deprecated.
DataCodecInfo[]	getDataCodecInfos()
protected <T> DatasetAccess<T>	getDatasetAccess() Get the DatasetAccess for this dataset.
DatasetCodecInfo[]	getDatasetCodecInfos()
DataType	getDataType()
com.google.gson.JsonElement	getDefaultValue()
long[]	getDimensions()
static DatasetAttributes.DatasetAttributesAdapter	getJsonAdapter()
Nesting.NestedGrid	getNestedBlockGrid() Returns the NestedGrid for this dataset, from which block and shard sizes are accessible.
int	getNumDimensions()
boolean	isSharded()
String	relativeBlockPath(long... position)

Methods inherited from class java.lang.Object

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

Field Detail

DIMENSIONS_KEY

public static final String DIMENSIONS_KEY

See Also:

Constant Field Values

BLOCK_SIZE_KEY

public static final String BLOCK_SIZE_KEY

See Also:

Constant Field Values

SHARD_SIZE_KEY

public static final String SHARD_SIZE_KEY

See Also:

Constant Field Values

DATA_TYPE_KEY

public static final String DATA_TYPE_KEY

See Also:

Constant Field Values

COMPRESSION_KEY

public static final String COMPRESSION_KEY

See Also:

Constant Field Values

CODEC_KEY

public static final String CODEC_KEY

See Also:

Constant Field Values

N5_DATASET_ATTRIBUTES

public static final String[] N5_DATASET_ATTRIBUTES

compressionTypeKey

protected static final String compressionTypeKey

See Also:

Constant Field Values

Constructor Detail

DatasetAttributes

public DatasetAttributes(long[] dimensions,
                         int[] blockSize,
                         DataType dataType,
                         com.google.gson.JsonElement defaultValue,
                         BlockCodecInfo blockCodecInfo,
                         DatasetCodecInfo[] datasetCodecInfos,
                         DataCodecInfo... dataCodecInfos)

DatasetAttributes

public DatasetAttributes(long[] dimensions,
                         int[] outerBlockSize,
                         DataType dataType,
                         BlockCodecInfo blockCodecInfo,
                         DatasetCodecInfo[] datasetCodecInfos,
                         DataCodecInfo... dataCodecInfos)

DatasetAttributes

public DatasetAttributes(long[] dimensions,
                         int[] outerBlockSize,
                         DataType dataType,
                         BlockCodecInfo blockCodecInfo,
                         DataCodecInfo... dataCodecInfos)

DatasetAttributes

public DatasetAttributes(long[] dimensions,
                         int[] blockSize,
                         DataType dataType,
                         DataCodecInfo... dataCodecInfos)

Constructs a DatasetAttributes instance with specified dimensions, block size, data type, and single compressor with default codec.

Parameters:

dimensions - the dimensions of the dataset

blockSize - the size of the blocks in the dataset

dataType - the data type of the dataset

dataCodecInfos - the codecs used encode/decode the data

DatasetAttributes

public DatasetAttributes(long[] dimensions,
                         int[] blockSize,
                         DataType dataType)

Constructs a DatasetAttributes instance with specified dimensions, block size, data type, and default codecs

Parameters:

dimensions - the dimensions of the dataset

blockSize - the size of the blocks in the dataset

dataType - the data type of the dataset

Method Detail

defaultBlockCodecInfo

protected BlockCodecInfo defaultBlockCodecInfo()

getDimensions

public long[] getDimensions()

getNumDimensions

public int getNumDimensions()

getChunkSize

public int[] getChunkSize()

getBlockSize

public int[] getBlockSize()

getDefaultValue

public com.google.gson.JsonElement getDefaultValue()

isSharded

public boolean isSharded()

getCompression

@Deprecated
public Compression getCompression()

Deprecated.

Only used for deserialization for N5 backwards compatibility. Compression is no longer a special case. Prefer to reference getDataCodecInfos() Will return RawCompression if no compression is otherwise provided, for legacy compatibility.

Deprecated in favor of getDataCodecInfos().

Returns:

compression CodecInfo, if one was present, or else RawCompression

getDataType

public DataType getDataType()

getDatasetAccess

protected <T> DatasetAccess<T> getDatasetAccess()

Get the DatasetAccess for this dataset.

Returns:

the DatasetAccess for this dataset

getNestedBlockGrid

public Nesting.NestedGrid getNestedBlockGrid()

Returns the NestedGrid for this dataset, from which block and shard sizes are accessible.

Returns:

the NestedGrid

getBlockCodecInfo

public BlockCodecInfo getBlockCodecInfo()

getDataCodecInfos

public DataCodecInfo[] getDataCodecInfos()

getDatasetCodecInfos

public DatasetCodecInfo[] getDatasetCodecInfos()

relativeBlockPath

public String relativeBlockPath(long... position)

asMap

public HashMap<String,Object> asMap()

builder

public static DatasetAttributes.Builder builder(long[] dimensions,
                                                DataType dataType)

builder

public static DatasetAttributes.Builder builder(DatasetAttributes attributes)

defaultBlockSize

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

getJsonAdapter

public static DatasetAttributes.DatasetAttributesAdapter getJsonAdapter()