org.janelia.saalfeldlab.n5.universe.metadata

Class N5GenericSingleScaleMetadataParser

java.lang.Object

org.janelia.saalfeldlab.n5.universe.metadata.N5GenericSingleScaleMetadataParser

All Implemented Interfaces:

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

public class N5GenericSingleScaleMetadataParser
extends Object
implements N5MetadataParser<N5SingleScaleMetadata>

A parser for N5SingleScaleMetadata with whose keys can be specified.

Author:

Caleb Hulbert, John Bogovic

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	N5GenericSingleScaleMetadataParser.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DOWNSAMPLING_FACTORS
static String	DEFAULT_MAX
static String	DEFAULT_MIN
static String	DEFAULT_OFFSET
static String	DEFAULT_RESOLUTION
static String	DEFAULT_UNIT
String	downsamplingFactorsKey
boolean	downsamplingFactorsKeyStrict
String	maxKey
boolean	maxKeyStrict
String	minKey
boolean	minKeyStrict
String	offsetKey
boolean	offsetKeyStrict
String	resolutionKey
boolean	resolutionKeyStrict
String	unitKey
boolean	unitKeyStrict

Constructor Summary

Constructors

Constructor and Description
N5GenericSingleScaleMetadataParser()
N5GenericSingleScaleMetadataParser(String minKey, String maxKey, String resolutionKey, String offsetKey, String unitKey, String downsamplingFactorsKey)

Method Summary

Modifier and Type	Method and Description
static N5GenericSingleScaleMetadataParser.Builder	builder()
static N5GenericSingleScaleMetadataParser.Builder	builder(boolean useDefaults)
Optional<N5SingleScaleMetadata>	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.

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

DEFAULT_MIN

public static final String DEFAULT_MIN

See Also:

Constant Field Values

DEFAULT_MAX

public static final String DEFAULT_MAX

See Also:

Constant Field Values

DEFAULT_RESOLUTION

public static final String DEFAULT_RESOLUTION

See Also:

Constant Field Values

DEFAULT_OFFSET

public static final String DEFAULT_OFFSET

See Also:

Constant Field Values

DEFAULT_UNIT

public static final String DEFAULT_UNIT

See Also:

Constant Field Values

DEFAULT_DOWNSAMPLING_FACTORS

public static final String DEFAULT_DOWNSAMPLING_FACTORS

See Also:

Constant Field Values

minKey

public final String minKey

maxKey

public final String maxKey

resolutionKey

public final String resolutionKey

offsetKey

public final String offsetKey

unitKey

public final String unitKey

downsamplingFactorsKey

public final String downsamplingFactorsKey

minKeyStrict

public boolean minKeyStrict

maxKeyStrict

public boolean maxKeyStrict

resolutionKeyStrict

public boolean resolutionKeyStrict

offsetKeyStrict

public boolean offsetKeyStrict

unitKeyStrict

public boolean unitKeyStrict

downsamplingFactorsKeyStrict

public boolean downsamplingFactorsKeyStrict

Constructor Detail

N5GenericSingleScaleMetadataParser

public N5GenericSingleScaleMetadataParser()

N5GenericSingleScaleMetadataParser

public N5GenericSingleScaleMetadataParser(String minKey,
                                          String maxKey,
                                          String resolutionKey,
                                          String offsetKey,
                                          String unitKey,
                                          String downsamplingFactorsKey)

Method Detail

builder

public static N5GenericSingleScaleMetadataParser.Builder builder()

builder

public static N5GenericSingleScaleMetadataParser.Builder builder(boolean useDefaults)

parseMetadata

public Optional<N5SingleScaleMetadata> 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<N5SingleScaleMetadata>

Parameters:

n5 - the reader

node - list of tree nodes

Returns:

the metadata