@fideus-labs/ngff-zarr 0.0.1 → 0.2.0

package/esm/types/rfc4.d.ts

@@ -0,0 +1,94 @@
+/**
+ * RFC 4 implementation for anatomical orientation in OME-NGFF.
+ *
+ * This module implements RFC 4 which adds anatomical orientation support
+ * to OME-NGFF axes, based on the LinkML schema.
+ */
+/**
+ * Anatomical orientation refers to the specific arrangement and directional
+ * alignment of anatomical structures within an imaging dataset. It is crucial
+ * for ensuring accurate alignment and comparison of images to anatomical atlases,
+ * facilitating consistent analysis and interpretation of biological data.
+ */
+export declare enum AnatomicalOrientationValues {
+    LeftToRight = "left-to-right",
+    RightToLeft = "right-to-left",
+    AnteriorToPosterior = "anterior-to-posterior",
+    PosteriorToAnterior = "posterior-to-anterior",
+    InferiorToSuperior = "inferior-to-superior",
+    SuperiorToInferior = "superior-to-inferior",
+    DorsalToVentral = "dorsal-to-ventral",
+    VentralToDorsal = "ventral-to-dorsal",
+    DorsalToPalmar = "dorsal-to-palmar",
+    PalmarToDorsal = "palmar-to-dorsal",
+    DorsalToPlantar = "dorsal-to-plantar",
+    PlantarToDorsal = "plantar-to-dorsal",
+    RostralToCaudal = "rostral-to-caudal",
+    CaudalToRostral = "caudal-to-rostral",
+    CranialToCaudal = "cranial-to-caudal",
+    CaudalToCranial = "caudal-to-cranial",
+    ProximalToDistal = "proximal-to-distal",
+    DistalToProximal = "distal-to-proximal"
+}
+/**
+ * Anatomical orientation specification for spatial axes.
+ */
+export interface AnatomicalOrientation {
+    readonly type: "anatomical";
+    readonly value: AnatomicalOrientationValues;
+}
+/**
+ * Create an anatomical orientation object.
+ */
+export declare function createAnatomicalOrientation(value: AnatomicalOrientationValues): AnatomicalOrientation;
+/**
+ * LPS (Left-Posterior-Superior) coordinate system orientations.
+ * In LPS, the axes increase from:
+ * - X: right-to-left (L = Left)
+ * - Y: anterior-to-posterior (P = Posterior)
+ * - Z: inferior-to-superior (S = Superior)
+ * This is the standard coordinate system used by ITK and many medical imaging applications.
+ */
+export declare const LPS: Record<string, AnatomicalOrientation>;
+/**
+ * RAS (Right-Anterior-Superior) coordinate system orientations.
+ * In RAS, the axes increase from:
+ * - X: left-to-right (R = Right)
+ * - Y: posterior-to-anterior (A = Anterior)
+ * - Z: inferior-to-superior (S = Superior)
+ * This coordinate system is commonly used in neuroimaging applications like FreeSurfer and FSL.
+ */
+export declare const RAS: Record<string, AnatomicalOrientation>;
+/**
+ * Convert ITK LPS coordinate system to anatomical orientation.
+ *
+ * ITK uses the LPS (Left-Posterior-Superior) coordinate system by default.
+ * In LPS, the axes increase from:
+ * - X: right-to-left (L = Left)
+ * - Y: anterior-to-posterior (P = Posterior)
+ * - Z: inferior-to-superior (S = Superior)
+ *
+ * @param axisName - The axis name ('x', 'y', or 'z')
+ * @returns The corresponding anatomical orientation, or undefined for non-spatial axes
+ */
+export declare function itkLpsToAnatomicalOrientation(axisName: string): AnatomicalOrientation | undefined;
+/**
+ * Check if RFC 4 is enabled in the list of enabled RFCs.
+ */
+export declare function isRfc4Enabled(enabledRfcs?: number[]): boolean;
+/**
+ * Add anatomical orientation to an axis object.
+ *
+ * @param axisDict - The axis object to modify
+ * @param orientation - The anatomical orientation to add
+ * @returns The modified axis object
+ */
+export declare function addAnatomicalOrientationToAxis(axisDict: Record<string, unknown>, orientation: AnatomicalOrientation): Record<string, unknown>;
+/**
+ * Remove anatomical orientation from an axis object.
+ *
+ * @param axisDict - The axis object to modify
+ * @returns The modified axis object
+ */
+export declare function removeAnatomicalOrientationFromAxis(axisDict: Record<string, unknown>): Record<string, unknown>;
+//# sourceMappingURL=rfc4.d.ts.map

package/esm/types/rfc4.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rfc4.d.ts","sourceRoot":"","sources":["../../src/types/rfc4.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH;;;;;GAKG;AACH,oBAAY,2BAA2B;IAErC,WAAW,kBAAkB;IAE7B,WAAW,kBAAkB;IAE7B,mBAAmB,0BAA0B;IAE7C,mBAAmB,0BAA0B;IAE7C,kBAAkB,yBAAyB;IAE3C,kBAAkB,yBAAyB;IAE3C,eAAe,sBAAsB;IAErC,eAAe,sBAAsB;IAErC,cAAc,qBAAqB;IAEnC,cAAc,qBAAqB;IAEnC,eAAe,sBAAsB;IAErC,eAAe,sBAAsB;IAErC,eAAe,sBAAsB;IAErC,eAAe,sBAAsB;IAErC,eAAe,sBAAsB;IAErC,eAAe,sBAAsB;IAErC,gBAAgB,uBAAuB;IAEvC,gBAAgB,uBAAuB;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,2BAA2B,CAAC;CAC7C;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,2BAA2B,GACjC,qBAAqB,CAKvB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAQrD,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAQrD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,MAAM,GACf,qBAAqB,GAAG,SAAS,CAEnC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAE7D;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,WAAW,EAAE,qBAAqB,GACjC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQzB;AAED;;;;;GAKG;AACH,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAGzB"}

package/esm/types/rfc4.js

@@ -0,0 +1,135 @@
+// SPDX-FileCopyrightText: Copyright (c) Fideus Labs LLC
+// SPDX-License-Identifier: MIT
+/**
+ * RFC 4 implementation for anatomical orientation in OME-NGFF.
+ *
+ * This module implements RFC 4 which adds anatomical orientation support
+ * to OME-NGFF axes, based on the LinkML schema.
+ */
+/**
+ * Anatomical orientation refers to the specific arrangement and directional
+ * alignment of anatomical structures within an imaging dataset. It is crucial
+ * for ensuring accurate alignment and comparison of images to anatomical atlases,
+ * facilitating consistent analysis and interpretation of biological data.
+ */
+export var AnatomicalOrientationValues;
+(function (AnatomicalOrientationValues) {
+    // Describes the directional orientation from the left side to the right lateral side of an anatomical structure or body
+    AnatomicalOrientationValues["LeftToRight"] = "left-to-right";
+    // Describes the directional orientation from the right side to the left lateral side of an anatomical structure or body
+    AnatomicalOrientationValues["RightToLeft"] = "right-to-left";
+    // Describes the directional orientation from the front (anterior) to the back (posterior) of an anatomical structure or body
+    AnatomicalOrientationValues["AnteriorToPosterior"] = "anterior-to-posterior";
+    // Describes the directional orientation from the back (posterior) to the front (anterior) of an anatomical structure or body
+    AnatomicalOrientationValues["PosteriorToAnterior"] = "posterior-to-anterior";
+    // Describes the directional orientation from below (inferior) to above (superior) in an anatomical structure or body
+    AnatomicalOrientationValues["InferiorToSuperior"] = "inferior-to-superior";
+    // Describes the directional orientation from above (superior) to below (inferior) in an anatomical structure or body
+    AnatomicalOrientationValues["SuperiorToInferior"] = "superior-to-inferior";
+    // Describes the directional orientation from the top/upper (dorsal) to the belly/lower (ventral) in an anatomical structure or body
+    AnatomicalOrientationValues["DorsalToVentral"] = "dorsal-to-ventral";
+    // Describes the directional orientation from the belly/lower (ventral) to the top/upper (dorsal) in an anatomical structure or body
+    AnatomicalOrientationValues["VentralToDorsal"] = "ventral-to-dorsal";
+    // Describes the directional orientation from the top/upper (dorsal) to the palm of the hand (palmar) in a body
+    AnatomicalOrientationValues["DorsalToPalmar"] = "dorsal-to-palmar";
+    // Describes the directional orientation from the palm of the hand (palmar) to the top/upper (dorsal) in a body
+    AnatomicalOrientationValues["PalmarToDorsal"] = "palmar-to-dorsal";
+    // Describes the directional orientation from the top/upper (dorsal) to the sole of the foot (plantar) in a body
+    AnatomicalOrientationValues["DorsalToPlantar"] = "dorsal-to-plantar";
+    // Describes the directional orientation from the sole of the foot (plantar) to the top/upper (dorsal) in a body
+    AnatomicalOrientationValues["PlantarToDorsal"] = "plantar-to-dorsal";
+    // Describes the directional orientation from the nasal (rostral) to the tail (caudal) end of an anatomical structure, typically used in reference to the central nervous system
+    AnatomicalOrientationValues["RostralToCaudal"] = "rostral-to-caudal";
+    // Describes the directional orientation from the tail (caudal) to the nasal (rostral) end of an anatomical structure, typically used in reference to the central nervous system
+    AnatomicalOrientationValues["CaudalToRostral"] = "caudal-to-rostral";
+    // Describes the directional orientation from the head (cranial) to the tail (caudal) end of an anatomical structure or body
+    AnatomicalOrientationValues["CranialToCaudal"] = "cranial-to-caudal";
+    // Describes the directional orientation from the tail (caudal) to the head (cranial) end of an anatomical structure or body
+    AnatomicalOrientationValues["CaudalToCranial"] = "caudal-to-cranial";
+    // Describes the directional orientation from the center of the body to the periphery of an anatomical structure or limb
+    AnatomicalOrientationValues["ProximalToDistal"] = "proximal-to-distal";
+    // Describes the directional orientation from the periphery of an anatomical structure or limb to the center of the body
+    AnatomicalOrientationValues["DistalToProximal"] = "distal-to-proximal";
+})(AnatomicalOrientationValues || (AnatomicalOrientationValues = {}));
+/**
+ * Create an anatomical orientation object.
+ */
+export function createAnatomicalOrientation(value) {
+    return {
+        type: "anatomical",
+        value,
+    };
+}
+/**
+ * LPS (Left-Posterior-Superior) coordinate system orientations.
+ * In LPS, the axes increase from:
+ * - X: right-to-left (L = Left)
+ * - Y: anterior-to-posterior (P = Posterior)
+ * - Z: inferior-to-superior (S = Superior)
+ * This is the standard coordinate system used by ITK and many medical imaging applications.
+ */
+export const LPS = {
+    x: createAnatomicalOrientation(AnatomicalOrientationValues.RightToLeft),
+    y: createAnatomicalOrientation(AnatomicalOrientationValues.AnteriorToPosterior),
+    z: createAnatomicalOrientation(AnatomicalOrientationValues.InferiorToSuperior),
+};
+/**
+ * RAS (Right-Anterior-Superior) coordinate system orientations.
+ * In RAS, the axes increase from:
+ * - X: left-to-right (R = Right)
+ * - Y: posterior-to-anterior (A = Anterior)
+ * - Z: inferior-to-superior (S = Superior)
+ * This coordinate system is commonly used in neuroimaging applications like FreeSurfer and FSL.
+ */
+export const RAS = {
+    x: createAnatomicalOrientation(AnatomicalOrientationValues.LeftToRight),
+    y: createAnatomicalOrientation(AnatomicalOrientationValues.PosteriorToAnterior),
+    z: createAnatomicalOrientation(AnatomicalOrientationValues.InferiorToSuperior),
+};
+/**
+ * Convert ITK LPS coordinate system to anatomical orientation.
+ *
+ * ITK uses the LPS (Left-Posterior-Superior) coordinate system by default.
+ * In LPS, the axes increase from:
+ * - X: right-to-left (L = Left)
+ * - Y: anterior-to-posterior (P = Posterior)
+ * - Z: inferior-to-superior (S = Superior)
+ *
+ * @param axisName - The axis name ('x', 'y', or 'z')
+ * @returns The corresponding anatomical orientation, or undefined for non-spatial axes
+ */
+export function itkLpsToAnatomicalOrientation(axisName) {
+    return LPS[axisName];
+}
+/**
+ * Check if RFC 4 is enabled in the list of enabled RFCs.
+ */
+export function isRfc4Enabled(enabledRfcs) {
+    return enabledRfcs !== undefined && enabledRfcs.includes(4);
+}
+/**
+ * Add anatomical orientation to an axis object.
+ *
+ * @param axisDict - The axis object to modify
+ * @param orientation - The anatomical orientation to add
+ * @returns The modified axis object
+ */
+export function addAnatomicalOrientationToAxis(axisDict, orientation) {
+    return {
+        ...axisDict,
+        orientation: {
+            type: orientation.type,
+            value: orientation.value,
+        },
+    };
+}
+/**
+ * Remove anatomical orientation from an axis object.
+ *
+ * @param axisDict - The axis object to modify
+ * @returns The modified axis object
+ */
+export function removeAnatomicalOrientationFromAxis(axisDict) {
+    const { orientation: _orientation, ...rest } = axisDict;
+    return rest;
+}

package/esm/types/units.d.ts

@@ -1,6 +1,6 @@
 export type SupportedDims = "c" | "x" | "y" | "z" | "t";
 export type SpatialDims = "x" | "y" | "z";
-export type AxesType = "time" | "space" | "channel";
+export type AxesType = "time" | "space" | "channel" | "array" | "coordinate" | "displacement";
 export type SpaceUnits = "angstrom" | "attometer" | "centimeter" | "decimeter" | "exameter" | "femtometer" | "foot" | "gigameter" | "hectometer" | "inch" | "kilometer" | "megameter" | "meter" | "micrometer" | "mile" | "millimeter" | "nanometer" | "parsec" | "petameter" | "picometer" | "terameter" | "yard" | "yoctometer" | "yottameter" | "zeptometer" | "zettameter";
 export type TimeUnits = "attosecond" | "centisecond" | "day" | "decisecond" | "exasecond" | "femtosecond" | "gigasecond" | "hectosecond" | "hour" | "kilosecond" | "megasecond" | "microsecond" | "millisecond" | "minute" | "nanosecond" | "petasecond" | "picosecond" | "second" | "terasecond" | "yoctosecond" | "yottasecond" | "zeptosecond" | "zettasecond";
 export type Units = SpaceUnits | TimeUnits;

package/esm/types/units.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../src/types/units.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAE1C,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEpD,MAAM,MAAM,UAAU,GAClB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,YAAY,GACZ,MAAM,GACN,WAAW,GACX,YAAY,GACZ,MAAM,GACN,WAAW,GACX,WAAW,GACX,OAAO,GACP,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,WAAW,GACX,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,YAAY,CAAC;AAEjB,MAAM,MAAM,SAAS,GACjB,YAAY,GACZ,aAAa,GACb,KAAK,GACL,YAAY,GACZ,WAAW,GACX,aAAa,GACb,YAAY,GACZ,aAAa,GACb,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,aAAa,GACb,QAAQ,GACR,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,YAAY,GACZ,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,CAAC;AAElB,MAAM,MAAM,KAAK,GAAG,UAAU,GAAG,SAAS,CAAC;AAE3C,eAAO,MAAM,aAAa,EAAE,aAAa,EAA8B,CAAC;AAExE,eAAO,MAAM,UAAU,EAAE,UAAU,EA2BlC,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,SAAS,EAwBhC,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,aAAa,CAEtE;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,KAAK,CAK3D"}
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../src/types/units.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAE1C,MAAM,MAAM,QAAQ,GAChB,MAAM,GACN,OAAO,GACP,SAAS,GACT,OAAO,GACP,YAAY,GACZ,cAAc,CAAC;AAEnB,MAAM,MAAM,UAAU,GAClB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,YAAY,GACZ,MAAM,GACN,WAAW,GACX,YAAY,GACZ,MAAM,GACN,WAAW,GACX,WAAW,GACX,OAAO,GACP,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,WAAW,GACX,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,YAAY,CAAC;AAEjB,MAAM,MAAM,SAAS,GACjB,YAAY,GACZ,aAAa,GACb,KAAK,GACL,YAAY,GACZ,WAAW,GACX,aAAa,GACb,YAAY,GACZ,aAAa,GACb,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,aAAa,GACb,QAAQ,GACR,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,YAAY,GACZ,aAAa,GACb,aAAa,GACb,aAAa,GACb,aAAa,CAAC;AAElB,MAAM,MAAM,KAAK,GAAG,UAAU,GAAG,SAAS,CAAC;AAE3C,eAAO,MAAM,aAAa,EAAE,aAAa,EAA8B,CAAC;AAExE,eAAO,MAAM,UAAU,EAAE,UAAU,EA2BlC,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,SAAS,EAwBhC,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,aAAa,CAEtE;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,KAAK,CAK3D"}

package/esm/types/zarr_metadata.d.ts

@@ -21,18 +21,25 @@ export interface Dataset {
     coordinateTransformations: Transform[];
 }
 export interface OmeroWindow {
-    min: number;
-    max: number;
-    start: number;
-    end: number;
+    min?: number;
+    max?: number;
+    start?: number;
+    end?: number;
 }
 export interface OmeroChannel {
     color: string;
     window: OmeroWindow;
-    label: string | undefined;
+    label?: string;
+    active?: boolean;
 }
 export interface Omero {
     channels: OmeroChannel[];
+    version?: string;
+}
+export interface MethodMetadata {
+    description: string;
+    method: string;
+    version: string;
 }
 export interface Metadata {
     axes: Axis[];
@@ -41,6 +48,8 @@ export interface Metadata {
     omero: Omero | undefined;
     name: string;
     version: string;
+    type?: string;
+    metadata?: MethodMetadata;
 }
 export declare function validateColor(color: string): void;
 export declare function createScale(scale: number[]): Scale;

package/esm/types/zarr_metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zarr_metadata.d.ts","sourceRoot":"","sources":["../../src/types/zarr_metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjE,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,KAAK,GAAG,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,WAAW,CAAC;AAE5C,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB,EAAE,SAAS,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,WAAW,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,IAAI,EAAE,CAAC;IACb,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,yBAAyB,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACnD,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAMjD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAElD;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,WAAW,CAEpE;AAED,wBAAgB,cAAc,IAAI,QAAQ,CAEzC"}
+{"version":3,"file":"zarr_metadata.d.ts","sourceRoot":"","sources":["../../src/types/zarr_metadata.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjE,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,KAAK,GAAG,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,WAAW,CAAC;AAE5C,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB,EAAE,SAAS,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,WAAW,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,IAAI,EAAE,CAAC;IACb,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,yBAAyB,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACnD,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAIjD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAElD;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,WAAW,CAEpE;AAED,wBAAgB,cAAc,IAAI,QAAQ,CAEzC"}

package/esm/utils/create_queue.d.ts

@@ -0,0 +1,6 @@
+export type ChunkQueue = {
+    add(fn: () => Promise<void>): void;
+    onIdle(): Promise<void>;
+};
+export declare function createQueue(): ChunkQueue;
+//# sourceMappingURL=create_queue.d.ts.map

package/esm/utils/create_queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create_queue.d.ts","sourceRoot":"","sources":["../../src/utils/create_queue.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACnC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEF,wBAAgB,WAAW,IAAI,UAAU,CAOxC"}

package/esm/utils/create_queue.js

@@ -0,0 +1,11 @@
+// SPDX-FileCopyrightText: Copyright (c) Fideus Labs LLC
+// SPDX-License-Identifier: MIT
+import PQueue from "p-queue";
+export function createQueue() {
+    const concurrency = Math.min(navigator?.hardwareConcurrency || 4, 128);
+    const queue = new PQueue({ concurrency });
+    return {
+        add: (fn) => queue.add(fn),
+        onIdle: queue.onIdle.bind(queue),
+    };
+}

package/esm/utils/factory.d.ts

@@ -3,7 +3,7 @@ import { Multiscales } from "../types/multiscales.js";
 import type { Axis, Dataset, Metadata, Scale, Translation } from "../types/zarr_metadata.js";
 import type { AxesType, SupportedDims, Units } from "../types/units.js";
 import type { Methods } from "../types/methods.js";
-export declare function createNgffImage(_data: ArrayBuffer | number[], shape: number[], dtype: string, dims: string[], scale: Record<string, number>, translation: Record<string, number>, name?: string): NgffImage;
+export declare function createNgffImage(_data: ArrayBuffer | number[], shape: number[], dtype: string, dims: string[], scale: Record<string, number>, translation: Record<string, number>, name?: string): Promise<NgffImage>;
 export declare function createAxis(name: SupportedDims, type: AxesType, unit?: Units): Axis;
 export declare function createScale(scale: number[]): Scale;
 export declare function createTranslation(translation: number[]): Translation;

package/esm/utils/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/utils/factory.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EACV,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,KAAK,EACL,WAAW,EACZ,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,wBAAgB,eAAe,CAC7B,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,EAC7B,KAAK,EAAE,MAAM,EAAE,EACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EAAE,EACd,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,IAAI,SAAU,GACb,SAAS,CAiBX;AAED,wBAAgB,UAAU,CACxB,IAAI,EAAE,aAAa,EACnB,IAAI,EAAE,QAAQ,EACd,IAAI,CAAC,EAAE,KAAK,GACX,IAAI,CAMN;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAKlD;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,WAAW,CAKpE;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAQT;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EAAE,EACZ,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,SAAU,EACd,OAAO,SAAQ,GACd,QAAQ,CASV;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,SAAS,EAAE,EACnB,QAAQ,EAAE,QAAQ,EAClB,YAAY,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,EAClD,MAAM,CAAC,EAAE,OAAO,GACf,WAAW,CAQb"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/utils/factory.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EACV,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,KAAK,EACL,WAAW,EACZ,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAsBnD,wBAAsB,eAAe,CACnC,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE,EAC7B,KAAK,EAAE,MAAM,EAAE,EACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EAAE,EACd,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,IAAI,SAAU,GACb,OAAO,CAAC,SAAS,CAAC,CAYpB;AAED,wBAAgB,UAAU,CACxB,IAAI,EAAE,aAAa,EACnB,IAAI,EAAE,QAAQ,EACd,IAAI,CAAC,EAAE,KAAK,GACX,IAAI,CAMN;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAKlD;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,WAAW,CAKpE;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAQT;AAED,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EAAE,EACZ,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,SAAU,EACd,OAAO,SAAQ,GACd,QAAQ,CASV;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,SAAS,EAAE,EACnB,QAAQ,EAAE,QAAQ,EAClB,YAAY,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,EAClD,MAAM,CAAC,EAAE,OAAO,GACf,WAAW,CAQb"}

package/esm/utils/factory.js

@@ -1,15 +1,24 @@
-import { LazyArray } from "../types/lazy_array.js";
+// SPDX-FileCopyrightText: Copyright (c) Fideus Labs LLC
+// SPDX-License-Identifier: MIT
+import * as zarr from "zarrita";
 import { NgffImage } from "../types/ngff_image.js";
 import { Multiscales } from "../types/multiscales.js";
-export function createNgffImage(_data, shape, dtype, dims, scale, translation, name = "image") {
-    const lazyArray = new LazyArray({
+// Create a zarr.Array for testing using an in-memory store
+async function createTestZarrArray(shape, dtype, chunks, name) {
+    const store = new Map();
+    const root = zarr.root(store);
+    // Create the array using zarrita with correct options
+    const array = await zarr.create(root.resolve(name), {
         shape,
-        dtype,
-        chunks: [shape],
-        name,
+        chunk_shape: chunks,
+        data_type: dtype,
     });
+    return array;
+}
+export async function createNgffImage(_data, shape, dtype, dims, scale, translation, name = "image") {
+    const zarrArray = await createTestZarrArray(shape, dtype, shape, name);
     return new NgffImage({
-        data: lazyArray,
+        data: zarrArray,
         dims,
         scale,
         translation,

package/esm/utils/method_metadata.d.ts

@@ -0,0 +1,10 @@
+import type { Methods } from "../types/methods.js";
+import type { MethodMetadata } from "../types/zarr_metadata.js";
+/**
+ * Get metadata information for a given downsampling method.
+ *
+ * @param method - The downsampling method enum
+ * @returns MethodMetadata with description, method (package.function), and version
+ */
+export declare function getMethodMetadata(method: Methods): MethodMetadata | undefined;
+//# sourceMappingURL=method_metadata.d.ts.map

package/esm/utils/method_metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"method_metadata.d.ts","sourceRoot":"","sources":["../../src/utils/method_metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AA6BhE;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,cAAc,GAAG,SAAS,CAe7E"}

package/esm/utils/method_metadata.js

@@ -0,0 +1,37 @@
+const METHOD_INFO = {
+    itkwasm_gaussian: {
+        description: "Smoothed with a discrete gaussian filter to generate a scale space, ideal for intensity images. ITK-Wasm implementation is extremely portable and SIMD accelerated.",
+        package: "itkwasm-downsample",
+        method: "itkwasm_downsample.downsample",
+    },
+    itkwasm_bin_shrink: {
+        description: "Uses the local mean for the output value. WebAssembly build. Fast but generates more artifacts than gaussian-based methods. Appropriate for intensity images.",
+        package: "itkwasm-downsample",
+        method: "itkwasm_downsample.downsample_bin_shrink",
+    },
+    itkwasm_label_image: {
+        description: "A sample is the mode of the linearly weighted local labels in the image. Fast and minimal artifacts. For label images.",
+        package: "itkwasm-downsample",
+        method: "itkwasm_downsample.downsample_label_image",
+    },
+};
+/**
+ * Get metadata information for a given downsampling method.
+ *
+ * @param method - The downsampling method enum
+ * @returns MethodMetadata with description, method (package.function), and version
+ */
+export function getMethodMetadata(method) {
+    const methodInfo = METHOD_INFO[method];
+    if (!methodInfo) {
+        return undefined;
+    }
+    // TODO: Determine package version dynamically if possible,
+    // For now use a placeholder
+    const version = "unknown";
+    return {
+        description: methodInfo.description,
+        method: methodInfo.method,
+        version,
+    };
+}

package/esm/utils/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAG1D,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAQ5D;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAIjD;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAErD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAyDjD"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAG1D,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAQ5D;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAIjD;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAErD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAyDjD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fideus-labs/ngff-zarr",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "TypeScript implementation of ngff-zarr for reading and writing OME-Zarr files",
   "keywords": [
     "ome-zarr",
@@ -39,9 +39,15 @@
     "LICENSE"
   ],
   "dependencies": {
+    "@itk-wasm/downsample": "^1.8.1",
+    "itk-wasm": "^1.0.0-b.195",
+    "p-queue": "^8.1.0",
     "@zarrita/storage": "^0.1.1",
     "zod": "^4.0.2",
     "zarrita": "^0.5.2"
   },
+  "devDependencies": {
+    "@itk-wasm/image-io": "^1.6.0"
+  },
   "_generatedBy": "dnt@dev"
 }

package/script/io/from_ngff_zarr.d.ts

@@ -1,7 +1,10 @@
+import * as zarr from "zarrita";
 import { Multiscales } from "../types/multiscales.js";
 export interface FromNgffZarrOptions {
     validate?: boolean;
+    version?: "0.4" | "0.5";
 }
-export declare function fromNgffZarr(storePath: string, options?: FromNgffZarrOptions): Promise<Multiscales>;
+export type MemoryStore = Map<string, Uint8Array>;
+export declare function fromNgffZarr(store: string | MemoryStore | zarr.FetchStore, options?: FromNgffZarrOptions): Promise<Multiscales>;
 export declare function readArrayData(storePath: string, arrayPath: string, selection?: (number | null)[]): Promise<unknown>;
 //# sourceMappingURL=from_ngff_zarr.d.ts.map

package/script/io/from_ngff_zarr.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"from_ngff_zarr.d.ts","sourceRoot":"","sources":["../../src/io/from_ngff_zarr.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAOtD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,wBAAsB,YAAY,CAChC,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,WAAW,CAAC,CAyItB;AAED,wBAAsB,aAAa,CACjC,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAC5B,OAAO,CAAC,OAAO,CAAC,CAoBlB"}
+{"version":3,"file":"from_ngff_zarr.d.ts","sourceRoot":"","sources":["../../src/io/from_ngff_zarr.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAMtD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;CACzB;AAED,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAElD,wBAAsB,YAAY,CAEhC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC,UAAU,EAC7C,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,WAAW,CAAC,CA6MtB;AAED,wBAAsB,aAAa,CACjC,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAC5B,OAAO,CAAC,OAAO,CAAC,CAmClB"}