ZarrNET.TransposeCodec Class Reference

Zarr v3 transpose array-to-array codec. It permutes a decoded full-chunk buffer before it reaches the bytes codec, or reverses that permutation while decoding. More...

Inheritance diagram for ZarrNET.TransposeCodec:

Public Member Functions
	TransposeCodec (int[] order, int[] inputShape, int elementSize)
Task< byte[]>	EncodeAsync (byte[] input, CancellationToken ct=default)
	Encodes bytes for the next codec step.
Task< byte[]>	DecodeAsync (byte[] input, CancellationToken ct=default)
	Decodes bytes produced by the previous codec step.
Public Member Functions inherited from ZarrNET.IZarrCodec

Properties
string	Name [get]
	Codec name as it appears in zarr.json (e.g. "gzip", "zstd", "bytes").
Properties inherited from ZarrNET.IZarrCodec

Detailed Description

Zarr v3 transpose array-to-array codec. It permutes a decoded full-chunk buffer before it reaches the bytes codec, or reverses that permutation while decoding.

Constructor & Destructor Documentation

TransposeCodec()

ZarrNET.TransposeCodec.TransposeCodec	(	int[]	order,
		int[]	inputShape,
		int	elementSize )

    {
        ArgumentNullException.ThrowIfNull(order);
        ArgumentNullException.ThrowIfNull(inputShape);
        if (order.Length != inputShape.Length || order.Order().Distinct().Count() != order.Length ||
            order.Any(axis => axis < 0 || axis >= inputShape.Length))
            throw new ArgumentException("Transpose order must be a permutation of every chunk axis.", nameof(order));
        if (inputShape.Any(size => size <= 0))
            throw new ArgumentOutOfRangeException(nameof(inputShape), "Chunk dimensions must be positive.");
        if (elementSize <= 0) throw new ArgumentOutOfRangeException(nameof(elementSize));
 
        _order = order.ToArray();
        _inputShape = inputShape.ToArray();
        _outputShape = order.Select(axis => inputShape[axis]).ToArray();
        _elementSize = elementSize;
    }

Member Function Documentation

DecodeAsync()

Task< byte[]> ZarrNET.TransposeCodec.DecodeAsync	(	byte[]	input,
		CancellationToken	ct = default )

Decodes bytes produced by the previous codec step.

Implements ZarrNET.IZarrCodec.

EncodeAsync()

Task< byte[]> ZarrNET.TransposeCodec.EncodeAsync	(	byte[]	input,
		CancellationToken	ct = default )

Encodes bytes for the next codec step.

Implements ZarrNET.IZarrCodec.

Property Documentation

Name

string ZarrNET.TransposeCodec.Name

get

Codec name as it appears in zarr.json (e.g. "gzip", "zstd", "bytes").

Implements ZarrNET.IZarrCodec.

---

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

• ZarrNET/TransposeCodec.cs