org.janelia.saalfeldlab.n5.universe.metadata.canonical

Class SpatialMetadataCanonical

java.lang.Object

org.janelia.saalfeldlab.n5.universe.metadata.canonical.SpatialMetadataCanonical

All Implemented Interfaces:

AxisMetadata, N5Metadata, SpatialMetadata

public class SpatialMetadataCanonical
extends Object
implements SpatialMetadata, AxisMetadata

Interface for metadata describing how spatial data are oriented in physical space.

Author:

Caleb Hulbert, John Bogovic

Constructor Summary

Constructors

Constructor and Description
SpatialMetadataCanonical(String path, CalibratedSpatialTransform calTransform, Axis[] axes)
SpatialMetadataCanonical(String path, SpatialTransform transform, String unit, Axis[] axes)

Method Summary

Modifier and Type	Method and Description
Axis[]	getAxes()
String[]	getAxisLabels()
String[]	getAxisTypes()
String	getPath()
String[]	getUnits()
net.imglib2.realtransform.AffineGet	spatialTransform()
SpatialTransform	transform()
String	unit()

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.SpatialMetadata

spatialTransform3d

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

getName

Methods inherited from interface org.janelia.saalfeldlab.n5.universe.metadata.axes.AxisMetadata

getAxis, indexesOfType, indexOf

Constructor Detail

SpatialMetadataCanonical

public SpatialMetadataCanonical(String path,
                                SpatialTransform transform,
                                String unit,
                                Axis[] axes)

SpatialMetadataCanonical

public SpatialMetadataCanonical(String path,
                                CalibratedSpatialTransform calTransform,
                                Axis[] axes)

Method Detail

transform

public SpatialTransform transform()

spatialTransform

public net.imglib2.realtransform.AffineGet spatialTransform()

Specified by:

spatialTransform in interface SpatialMetadata

Returns:

a copy of the transformation from pixel to physical space.

unit

public String unit()

Specified by:

unit in interface SpatialMetadata

getPath

public String getPath()

Specified by:

getPath in interface N5Metadata

Returns:

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

getAxes

public Axis[] getAxes()

Specified by:

getAxes in interface AxisMetadata

getAxisLabels

public String[] getAxisLabels()

Specified by:

getAxisLabels in interface AxisMetadata

getAxisTypes

public String[] getAxisTypes()

Specified by:

getAxisTypes in interface AxisMetadata

getUnits

public String[] getUnits()

Specified by:

getUnits in interface AxisMetadata