org.janelia.saalfeldlab.n5

Interface DataBlock<T>

Type Parameters:

T - type of the data contained in the DataBlock

All Known Implementing Classes:

AbstractDataBlock, ByteArrayDataBlock, DoubleArrayDataBlock, FloatArrayDataBlock, IntArrayDataBlock, LongArrayDataBlock, RawShardDataBlock, ShortArrayDataBlock, StringDataBlock

public interface DataBlock<T>

Interface for data blocks. A data block has data, a position on the block grid, and a size.

Author:

Stephan Saalfeld

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DataBlock.DataBlockFactory<T> Factory for creating DataBlock<T>.

Method Summary

Modifier and Type	Method and Description
T	getData() Returns the data object held by this data block.
long[]	getGridPosition() Returns the position of this data block on the block grid relative to dataset.
int	getNumElements() Returns the number of elements in this DataBlock.
static int	getNumElements(int[] size) Returns the number of elements in a box of given size.
int[]	getSize() Returns the size of this data block.

Method Detail

getSize

int[] getSize()

Returns the size of this data block.

The size of a data block is expected to be smaller than or equal to the spacing of the block grid. The dimensionality of size is expected to be equal to the dimensionality of the dataset. Consistency is not enforced.

Returns:

size of the data block

getGridPosition

long[] getGridPosition()

Returns the position of this data block on the block grid relative to dataset.

The dimensionality of the grid position is expected to be equal to the dimensionality of the dataset. Consistency is not enforced.

Returns:

position on the block grid

getData

T getData()

Returns the data object held by this data block.

Returns:

data object

getNumElements

int getNumElements()

Returns the number of elements in this DataBlock. This number is not necessarily equal getNumElements(getSize()).

Returns:

the number of elements

getNumElements

static int getNumElements(int[] size)

Returns the number of elements in a box of given size.

Parameters:

size - the size

Returns:

the number of elements