org.janelia.saalfeldlab.n5.universe.metadata.ome.ngff

Class OmeNgffMetadataParser

java.lang.Object

org.janelia.saalfeldlab.n5.universe.metadata.ome.ngff.OmeNgffMetadataParser

All Implemented Interfaces:

BiFunction<org.janelia.saalfeldlab.n5.N5Reader,N5TreeNode,Optional<OmeNgffMetadata>>, N5MetadataParser<OmeNgffMetadata>, N5MetadataWriter<OmeNgffMetadata>

public class OmeNgffMetadataParser
extends Object
implements N5MetadataParser<OmeNgffMetadata>, N5MetadataWriter<OmeNgffMetadata>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	reverse

Constructor Summary

Constructors

Constructor and Description
OmeNgffMetadataParser()
OmeNgffMetadataParser(boolean reverse)
OmeNgffMetadataParser(org.janelia.saalfeldlab.n5.N5Reader n5)

Method Summary

Modifier and Type	Method and Description
com.google.gson.GsonBuilder	gsonBuilder()
Optional<OmeNgffMetadata>	parseMetadata(org.janelia.saalfeldlab.n5.N5Reader n5, N5TreeNode node) Called by the N5DatasetDiscoverer while discovering the N5 tree and filling the metadata for datasets or groups.
static boolean	reverse(org.janelia.saalfeldlab.n5.N5Reader n5)
void	writeMetadata(OmeNgffMetadata t, org.janelia.saalfeldlab.n5.N5Writer n5, String groupPath) Writes metadata to a dataset or group in an N5 container.

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

apply, parseDatasetAttributes, parseMetadata

Methods inherited from interface java.util.function.BiFunction

andThen

Field Detail

reverse

protected boolean reverse

Constructor Detail

OmeNgffMetadataParser

public OmeNgffMetadataParser(boolean reverse)

OmeNgffMetadataParser

public OmeNgffMetadataParser(org.janelia.saalfeldlab.n5.N5Reader n5)

OmeNgffMetadataParser

public OmeNgffMetadataParser()

Method Detail

reverse

public static boolean reverse(org.janelia.saalfeldlab.n5.N5Reader n5)

gsonBuilder

public com.google.gson.GsonBuilder gsonBuilder()

parseMetadata

public Optional<OmeNgffMetadata> parseMetadata(org.janelia.saalfeldlab.n5.N5Reader n5,
                                               N5TreeNode node)

Description copied from interface: N5MetadataParser

Called by the N5DatasetDiscoverer while discovering the N5 tree and filling the metadata for datasets or groups.

The metadata parsing is done in the bottom-up fashion, so the children of the given node have already been processed and should already contain valid metadata (if any).

Specified by:

parseMetadata in interface N5MetadataParser<OmeNgffMetadata>

Parameters:

n5 - the reader

node - list of tree nodes

Returns:

the metadata

writeMetadata

public void writeMetadata(OmeNgffMetadata t,
                          org.janelia.saalfeldlab.n5.N5Writer n5,
                          String groupPath)
                   throws Exception

Description copied from interface: N5MetadataWriter

Writes metadata to a dataset or group in an N5 container.

Specified by:

writeMetadata in interface N5MetadataWriter<OmeNgffMetadata>

Parameters:

t - metadata

n5 - the n5 writer

groupPath - the path relative to the container root of the group or dataset

Throws:

Exception - the exception