ZarrNET.ZarrArrayMetadata Class Reference

Typed metadata for a Zarr array node. Knows everything needed to read/write chunks — shape, data type, chunk layout, codec pipeline configuration. No OME-Zarr knowledge here. More...

Static Public Member Functions
static ZarrArrayMetadata	FromDocument (ZarrJsonDocument doc)
static ZarrArrayMetadata	FromV2Document (ZarrV2ArrayDocument arrayDoc, JsonElement? attributes, string? separatorOverride=null)
	Creates array metadata from a Zarr v2 .zarray document.

Properties
long[]	Shape [get]
int[]	ChunkShape [get]
ZarrDataType	DataType [get]
string	ChunkKeySeparator [get]
CodecInfo[]	Codecs [get]
string?[]	DimensionNames [get]
JsonElement?	RawAttributes [get]
int	ZarrVersion [get]
ShardingConfig?	Sharding [get, set]
	Non-null when the codec pipeline contains a sharding_indexed codec. In this case, the outer ChunkShape represents the shard shape and actual data chunks are the inner chunks within each shard.
int	Rank [get]

Detailed Description

Typed metadata for a Zarr array node. Knows everything needed to read/write chunks — shape, data type, chunk layout, codec pipeline configuration. No OME-Zarr knowledge here.

Member Function Documentation

FromDocument()

static ZarrArrayMetadata ZarrNET.ZarrArrayMetadata.FromDocument ( ZarrJsonDocument doc )

static

    {
        if (doc.NodeType != "array")
            throw new InvalidOperationException(
                $"Expected node_type 'array', got '{doc.NodeType}'.");
 
        if (doc.Shape is null)
            throw new InvalidOperationException("Array zarr.json is missing 'shape'.");
 
        if (doc.DataType is null)
            throw new InvalidOperationException("Array zarr.json is missing 'data_type'.");
 
        var shape      = doc.Shape;
        var dataType   = ZarrDataType.Parse(doc.DataType);
        var chunkShape = ResolveChunkShape(doc);
        var separator  = doc.ChunkKeyEncoding?.Configuration?.Separator ?? "/";
        var codecs     = ResolveCodecs(doc);
 
        return new ZarrArrayMetadata(
            shape,
            chunkShape,
            dataType,
            separator,
            codecs,
            doc.DimensionNames,
            doc.Attributes,
            zarrVersion: 3);
    }

FromV2Document()

static ZarrArrayMetadata ZarrNET.ZarrArrayMetadata.FromV2Document ( ZarrV2ArrayDocument arrayDoc, JsonElement? attributes, string? separatorOverride = null )

static

Creates array metadata from a Zarr v2 .zarray document.

Parameters

arrayDoc	Parsed .zarray contents.
attributes	Parsed .zattrs contents (optional).
separatorOverride	If provided, overrides the dimension separator regardless of what .zarray declares. Used by the chunk-key probing logic when .zarray omits dimension_separator and the store is found to use "/" (nested) chunk keys.

    {
        if (arrayDoc.ZarrFormat != 2)
            throw new InvalidOperationException(
                $"Expected zarr_format 2, got {arrayDoc.ZarrFormat}.");
 
        var (dataType, byteOrder) = NumpyDtypeParser.Parse(arrayDoc.Dtype);
 
        var separator = separatorOverride
                     ?? arrayDoc.DimensionSeparator
                     ?? ".";
 
        var codecs = CodecFactory.BuildV2CodecPipeline(arrayDoc.Compressor, byteOrder);
 
        return new ZarrArrayMetadata(
            arrayDoc.Shape,
            arrayDoc.Chunks,
            dataType,
            separator,
            codecs,
            dimensionNames: null,   // v2 doesn't have dimension_names
            attributes,
            zarrVersion: 2);
    }

Property Documentation

ChunkKeySeparator

string ZarrNET.ZarrArrayMetadata.ChunkKeySeparator

get

{ get; }

ChunkShape

int [] ZarrNET.ZarrArrayMetadata.ChunkShape

get

{ get; }

Codecs

CodecInfo [] ZarrNET.ZarrArrayMetadata.Codecs

get

{ get; }

DataType

ZarrDataType ZarrNET.ZarrArrayMetadata.DataType

get

{ get; }

DimensionNames

string? [] ZarrNET.ZarrArrayMetadata.DimensionNames

get

{ get; }

RawAttributes

JsonElement? ZarrNET.ZarrArrayMetadata.RawAttributes

get

{ get; }

Shape

long [] ZarrNET.ZarrArrayMetadata.Shape

get

{ get; }

Sharding

ShardingConfig? ZarrNET.ZarrArrayMetadata.Sharding

getset

Non-null when the codec pipeline contains a sharding_indexed codec. In this case, the outer ChunkShape represents the shard shape and actual data chunks are the inner chunks within each shard.

{ get; internal set; }

ZarrVersion

int ZarrNET.ZarrArrayMetadata.ZarrVersion

get

{ get; }   // 2 or 3 — drives chunk key format

---

The documentation for this class was generated from the following file:

• ZarrNET/ZarrNodeMetadata.cs