org.janelia.saalfeldlab.n5.codec

Interface DatasetCodec<S,T>

Type Parameters:

S - source data type (data contained in decoded blocks)

T - target data type (data contained in encoded blocks)

All Known Implementing Classes:

TransposeCodec

public interface DatasetCodec<S,T>

A Codec that transforms the contents of a DataBlock.

This class is N5's analogue to Zarr's array-to-array codec.

Method Summary

Modifier and Type	Method and Description
static <S,T> BlockCodec<S>	concatenate(DatasetCodec<S,T> datasetCodec, BlockCodec<T> blockCodec) Create a BlockCodec that, for encoding, first applies datasetCodec and then blockCodec (and does the same in reverse order for decoding).
DataBlock<S>	decode(DataBlock<T> dataBlock)
DataBlock<T>	encode(DataBlock<S> block)

Method Detail

encode

DataBlock<T> encode(DataBlock<S> block)
             throws N5Exception.N5IOException

Throws:

N5Exception.N5IOException

decode

DataBlock<S> decode(DataBlock<T> dataBlock)
             throws N5Exception.N5IOException

Throws:

N5Exception.N5IOException

concatenate

static <S,T> BlockCodec<S> concatenate(DatasetCodec<S,T> datasetCodec,
                                       BlockCodec<T> blockCodec)

Create a BlockCodec that, for encoding, first applies datasetCodec and then blockCodec (and does the same in reverse order for decoding).

Type Parameters:

S - the source type of this codec

T - the target type of this codec

Parameters:

datasetCodec - the DatasetCodec to apply

blockCodec - the wrapped BlockCodec

Returns:

the concatenated BlockCodec