org.janelia.saalfeldlab.n5.universe.metadata

Class MultiscaleMetadata<T extends N5DatasetMetadata & SpatialMetadata>

java.lang.Object

org.janelia.saalfeldlab.n5.universe.metadata.MultiscaleMetadata<T>

Type Parameters:

T - metadata type

All Implemented Interfaces:

N5Metadata, N5MetadataGroup<T>, SpatialMetadata, SpatialMetadataGroup<T>

Direct Known Subclasses:

SpatialMultiscaleMetadata

public abstract class MultiscaleMetadata<T extends N5DatasetMetadata & SpatialMetadata>
extends Object
implements SpatialMetadataGroup<T>

An abstract class for a SpatialMetadataGroup whose children contain the same data sampled at different resolutions.

Author:

Caleb Hulbert, John Bogovic

Field Summary

Fields

Modifier and Type	Field and Description
protected String	basePath
protected T[]	childrenMetadata

Constructor Summary

Constructors

Constructor and Description
MultiscaleMetadata(String basePath, T[] childrenMetadata)

Method Summary

Modifier and Type	Method and Description
T[]	getChildrenMetadata() Note: This is NOT gauranteeed to be sorted.
String	getPath()
String[]	getPaths()
static <T extends N5DatasetMetadata> boolean	sortScaleMetadata(T[] metadataToBeSorted) Sort the array according to scale level; If not all metadata are scale sets, no sorting is done.
String[]	units()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.janelia.saalfeldlab.n5.universe.metadata.SpatialMetadataGroup

spatialTransform, spatialTransform3d, spatialTransforms, spatialTransforms3d, unit

Methods inherited from interface org.janelia.saalfeldlab.n5.universe.metadata.N5Metadata

getName

Field Detail

basePath

protected final String basePath

childrenMetadata

protected final transient T extends N5DatasetMetadata & SpatialMetadata[] childrenMetadata

Constructor Detail

MultiscaleMetadata

public MultiscaleMetadata(String basePath,
                          T[] childrenMetadata)

Method Detail

getPath

public String getPath()

Specified by:

getPath in interface N5Metadata

Returns:

the path to this metadata, with respect to the base of the container

getPaths

public String[] getPaths()

Specified by:

getPaths in interface N5MetadataGroup<T extends N5DatasetMetadata & SpatialMetadata>

Returns:

an array of the paths to each of the children in this group, with respect to the base of the container

getChildrenMetadata

public T[] getChildrenMetadata()

Description copied from interface: N5MetadataGroup

Note: This is NOT gauranteeed to be sorted. Sort with

Specified by:

getChildrenMetadata in interface N5MetadataGroup<T extends N5DatasetMetadata & SpatialMetadata>

Returns:

an array of the metadata for the children of this group

units

public String[] units()

Specified by:

units in interface SpatialMetadataGroup<T extends N5DatasetMetadata & SpatialMetadata>

sortScaleMetadata

public static <T extends N5DatasetMetadata> boolean sortScaleMetadata(T[] metadataToBeSorted)

Sort the array according to scale level; If not all metadata are scale sets, no sorting is done. All metadata names as returned by N5Metadata::getName() should be of the form sN.

Type Parameters:

T - the type of the metadata

Parameters:

metadataToBeSorted - array of the unsorted scale metadata to be sorted

Returns:

are all dataset metadata scale levels