@fideus-labs/fiff 0.1.2 → 0.2.0

package/README.md

@@ -11,11 +11,13 @@
 </p>
 
 <p align="center">
-  Present <a href="https://docs.openmicroscopy.org/ome-model/latest/ome-tiff/">TIFF</a> and <a href="https://docs.openmicroscopy.org/ome-model/latest/ome-tiff/">OME-TIFF</a> files as a <a href="https://github.com/manzt/zarrita.js">zarrita.js</a> Zarr store following the <a href="https://ngff.openmicroscopy.org/0.5/">OME-Zarr v0.5</a> data model.
+  Read and write <a href="https://docs.openmicroscopy.org/ome-model/latest/ome-tiff/">OME-TIFF</a> files through a <a href="https://github.com/manzt/zarrita.js">zarrita.js</a> Zarr store following the <a href="https://ngff.openmicroscopy.org/0.5/">OME-Zarr v0.5</a> data model.
 </p>
 
 ## ✨ Features
 
+### Reading
+
 - 🚀 **Lazy HTTP range requests** -- Chunk data is fetched on demand via
   geotiff.js `readRasters()`, no full file download needed
 - 📐 **OME-XML support** -- Parses OME-XML metadata for dimensions, channels,
@@ -29,51 +31,192 @@
 - 📋 **OME-Zarr v0.5 output** -- Generates Zarr v3 metadata with
   `ome.multiscales` and `ome.omero` attributes
 
+### Writing
+
+- 📝 **OME-TIFF generation** -- Convert ngff-zarr `Multiscales` objects to
+  valid OME-TIFF files with embedded OME-XML metadata
+- 🔻 **Full pyramid support** -- Multi-resolution levels are written as SubIFDs,
+  matching the modern OME-TIFF pyramid convention
+- 🗜️ **Deflate compression** -- Optional zlib/deflate compression for smaller
+  files, compatible with all major TIFF readers
+- 📐 **5D support** -- Handles all dimension orders (XYZCT, XYZTC, etc.) and
+  arbitrary combinations of T, C, Z, Y, X axes
+
 ## 📦 Installation
 
 ```bash
 npm install @fideus-labs/fiff
 ```
 
-## ⚡ Quick Start
+For write support, also install the optional peer dependency:
+
+```bash
+npm install @fideus-labs/ngff-zarr
+```
+
+## ⚡ Usage
+
+### Reading: Open an OME-TIFF as a Zarr store
+
+#### From a remote URL
+
+```typescript
+import { TiffStore } from "@fideus-labs/fiff";
+import * as zarr from "zarrita";
+
+const store = await TiffStore.fromUrl("https://example.com/image.ome.tif");
+const group = await zarr.open(store as unknown as zarr.Readable, { kind: "group" });
+
+// Open the full-resolution array (level 0)
+const arr = await zarr.open(group.resolve("0"), { kind: "array" });
+const chunk = await zarr.get(arr);
+
+console.log(chunk.shape); // e.g. [1, 3, 1, 512, 512]
+console.log(chunk.data);  // Float32Array, Uint16Array, etc.
+```
+
+#### From an ArrayBuffer
+
+```typescript
+const response = await fetch("https://example.com/image.tif");
+const buffer = await response.arrayBuffer();
+const store = await TiffStore.fromArrayBuffer(buffer);
+```
+
+#### From a File / Blob
 
-### From a remote URL
+```typescript
+const file = document.querySelector("input[type=file]").files[0];
+const store = await TiffStore.fromBlob(file);
+```
+
+#### From an existing GeoTIFF instance
 
 ```typescript
-import { TiffStore } from "@fideus-labs/fiff"
-import * as zarr from "zarrita"
+import { fromUrl } from "geotiff";
+
+const tiff = await fromUrl("https://example.com/image.tif");
+const store = await TiffStore.fromGeoTIFF(tiff);
+```
 
-const store = await TiffStore.fromUrl("https://example.com/image.ome.tif")
-const group = await zarr.open(store as unknown as zarr.Readable, { kind: "group" })
-const arr = await zarr.open(group.resolve("0"), { kind: "array" })
-const chunk = await zarr.get(arr)
+#### Accessing store metadata
+
+```typescript
+const store = await TiffStore.fromUrl("https://example.com/image.ome.tif");
+
+store.levels;         // number of resolution levels
+store.dataType;       // "uint16", "float32", etc.
+store.dimensionNames; // ["t", "c", "z", "y", "x"]
+store.getShape(0);    // full-res shape, e.g. [1, 3, 1, 2048, 2048]
+store.getShape(1);    // level 1 shape, e.g. [1, 3, 1, 1024, 1024]
+store.ome;            // parsed OME-XML image metadata (if present)
+store.pyramidInfo;    // pyramid structure details
 ```
 
-### From an ArrayBuffer
+### Writing: Convert ngff-zarr Multiscales to OME-TIFF
+
+`toOmeTiff()` takes an ngff-zarr `Multiscales` object and returns a complete
+OME-TIFF file as an `ArrayBuffer`.
+
+#### Basic write
 
 ```typescript
-const response = await fetch("https://example.com/image.tif")
-const buffer = await response.arrayBuffer()
-const store = await TiffStore.fromArrayBuffer(buffer)
+import { toOmeTiff } from "@fideus-labs/fiff";
+import {
+  createNgffImage,
+  createAxis,
+  createDataset,
+  createMetadata,
+  createMultiscales,
+} from "@fideus-labs/ngff-zarr";
+import * as zarr from "zarrita";
+
+// 1. Create an ngff-zarr image
+const image = await createNgffImage(
+  [],              // no parent images
+  [512, 512],      // shape: [y, x]
+  "uint16",        // data type
+  ["y", "x"],      // dimension names
+  { y: 0.5, x: 0.5 },    // pixel spacing (micrometers)
+  { y: 0.0, x: 0.0 },    // origin offsets
+  "my-image",
+);
+
+// 2. Populate pixel data
+const data = new Uint16Array(512 * 512);
+for (let i = 0; i < data.length; i++) data[i] = i % 65536;
+await zarr.set(image.data, null, {
+  data,
+  shape: [512, 512],
+  stride: [512, 1],
+});
+
+// 3. Build the Multiscales object
+const axes = [
+  createAxis("y", "space", "micrometer"),
+  createAxis("x", "space", "micrometer"),
+];
+const datasets = [createDataset("0", [0.5, 0.5], [0.0, 0.0])];
+const metadata = createMetadata(axes, datasets, "my-image");
+const multiscales = createMultiscales([image], metadata);
+
+// 4. Write to OME-TIFF
+const buffer = await toOmeTiff(multiscales);
+
+// Save to disk (Node.js / Bun)
+await Bun.write("output.ome.tif", buffer);
 ```
 
-### From a File / Blob
+#### Write options
 
 ```typescript
-const file = document.querySelector("input[type=file]").files[0]
-const store = await TiffStore.fromBlob(file)
+const buffer = await toOmeTiff(multiscales, {
+  compression: "deflate",  // "deflate" (default) or "none"
+  compressionLevel: 6,     // 1-9, default 6 (only for deflate)
+  dimensionOrder: "XYZCT", // IFD layout order, default "XYZCT"
+  imageName: "my-image",   // name in OME-XML metadata
+  creator: "my-app",       // creator string in OME-XML
+});
 ```
 
-### From an existing GeoTIFF instance
+#### Multi-resolution pyramids
+
+When the `Multiscales` object contains multiple images (resolution levels),
+all sub-resolution levels are written as SubIFDs:
 
 ```typescript
-import { fromUrl } from "geotiff"
+const fullRes = await createNgffImage([], [1024, 1024], "uint16", ["y", "x"], ...);
+const halfRes = await createNgffImage([], [512, 512], "uint16", ["y", "x"], ...);
+// ... populate both images with zarr.set() ...
+
+const datasets = [
+  createDataset("0", [0.5, 0.5], [0.0, 0.0]),
+  createDataset("1", [1.0, 1.0], [0.0, 0.0]),
+];
+const metadata = createMetadata(axes, datasets, "pyramid");
+const multiscales = createMultiscales([fullRes, halfRes], metadata);
+
+const buffer = await toOmeTiff(multiscales);
+// Result: OME-TIFF with full-res IFDs + half-res SubIFDs
+```
+
+#### Round-trip: write then read back
 
-const tiff = await fromUrl("https://example.com/image.tif")
-const store = await TiffStore.fromGeoTIFF(tiff)
+```typescript
+import { toOmeTiff, TiffStore } from "@fideus-labs/fiff";
+import * as zarr from "zarrita";
+
+const buffer = await toOmeTiff(multiscales);
+const store = await TiffStore.fromArrayBuffer(buffer);
+const group = await zarr.open(store as unknown as zarr.Readable, { kind: "group" });
+const arr = await zarr.open(group.resolve("0"), { kind: "array" });
+const result = await zarr.get(arr);
+// result.data contains the original pixel values
 ```
 
-## 🏭 Factory Methods
+## 🏭 Read API
+
+### Factory Methods
 
 | Method                            | Description                                    |
 | --------------------------------- | ---------------------------------------------- |
@@ -82,7 +225,7 @@ const store = await TiffStore.fromGeoTIFF(tiff)
 | `TiffStore.fromBlob(blob)`        | Open from a Blob or File                       |
 | `TiffStore.fromGeoTIFF(tiff)`     | Open from an already-opened GeoTIFF instance   |
 
-## ⚙️ Options
+### Options
 
 All factory methods accept an optional `TiffStoreOptions` object:
 
@@ -91,7 +234,7 @@ All factory methods accept an optional `TiffStoreOptions` object:
 | `offsets` | `number[]`               | `undefined` | Pre-computed IFD byte offsets for O(1) access   |
 | `headers` | `Record<string, string>` | `undefined` | Additional HTTP headers for remote TIFF requests |
 
-## 📖 Public Accessors
+### Public Accessors
 
 | Accessor              | Type           | Description                        |
 | --------------------- | -------------- | ---------------------------------- |
@@ -103,6 +246,27 @@ All factory methods accept an optional `TiffStoreOptions` object:
 | `store.getShape(l)`   | `number[]`     | Shape for resolution level `l`     |
 | `store.getChunkShape(l)` | `number[]`  | Chunk shape for resolution level `l` |
 
+## 📝 Write API
+
+### `toOmeTiff(multiscales, options?)`
+
+| Parameter     | Type          | Description                                            |
+| ------------- | ------------- | ------------------------------------------------------ |
+| `multiscales` | `Multiscales` | ngff-zarr Multiscales object with populated pixel data |
+| `options`     | `WriteOptions`| Optional writer configuration                          |
+
+**Returns:** `Promise<ArrayBuffer>` -- a complete OME-TIFF file.
+
+### WriteOptions
+
+| Option             | Type                   | Default     | Description                              |
+| ------------------ | ---------------------- | ----------- | ---------------------------------------- |
+| `compression`      | `"none" \| "deflate"`  | `"deflate"` | Pixel data compression                   |
+| `compressionLevel` | `number`               | `6`         | Deflate level 1-9 (higher = smaller)     |
+| `dimensionOrder`   | `string`               | `"XYZCT"`   | IFD plane layout order                   |
+| `imageName`        | `string`               | `"image"`   | Image name in OME-XML                    |
+| `creator`          | `string`               | `"fiff"`    | Creator string in OME-XML                |
+
 ## 🛠️ Development
 
 ### 📋 Prerequisites
@@ -127,11 +291,14 @@ src/
   ome-xml.ts        # OME-XML parser (dimensions, channels, DimensionOrder)
   ifd-indexer.ts    # IFD-to-pyramid-level mapping (SubIFD/legacy/COG)
   chunk-reader.ts   # Pixel data reading via geotiff.js readRasters
-  dtypes.ts         # TIFF SampleFormat -> Zarr data_type mapping
+  dtypes.ts         # TIFF ↔ Zarr data_type mapping
   utils.ts          # Key parsing, pixel window computation, encoding
+  write.ts          # High-level toOmeTiff() writer
+  tiff-writer.ts    # Low-level TIFF binary builder (IFDs, SubIFDs, deflate)
+  ome-xml-writer.ts # OME-XML generation from Multiscales metadata
 test/
   fixtures.ts       # Test TIFF generation helpers
-  *.test.ts         # 120 tests across 8 files
+  *.test.ts         # 175 tests across 11 files
 ```
 
 ### 📝 Commands

package/dist/dtypes.d.ts

@@ -33,6 +33,21 @@ export declare function tiffDtypeToZarr(sampleFormat: number, bitsPerSample: num
 export declare function omePixelTypeToZarr(omeType: string): ZarrDataType;
 /** Number of bytes per element for a given Zarr data_type. */
 export declare function bytesPerElement(dtype: ZarrDataType): number;
+/**
+ * Map a Zarr v3 data_type string to an OME-XML pixel Type string.
+ * Reverse of omePixelTypeToZarr.
+ */
+export declare function zarrToOmePixelType(dtype: ZarrDataType): string;
+/** TIFF tag values for a given Zarr data_type. */
+export interface TiffDtypeInfo {
+    sampleFormat: number;
+    bitsPerSample: number;
+}
+/**
+ * Map a Zarr v3 data_type string to TIFF SampleFormat + BitsPerSample.
+ * Reverse of tiffDtypeToZarr.
+ */
+export declare function zarrToTiffDtype(dtype: ZarrDataType): TiffDtypeInfo;
 /**
  * Get the appropriate TypedArray constructor for a Zarr data_type.
  */

package/dist/dtypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dtypes.d.ts","sourceRoot":"","sources":["../src/dtypes.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AAEH,yCAAyC;AACzC,MAAM,MAAM,YAAY,GACpB,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,CAAC;AAEd,oCAAoC;AACpC,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC,eAAO,MAAM,iBAAiB,IAAI,CAAC;AACnC,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,GACpB,YAAY,CAyCd;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,CAiBhE;AAED,8DAA8D;AAC9D,wBAAgB,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAY3D;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,YAAY,GAClB;IACD,KAAK,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAC1D,UAAU,GACV,SAAS,GACT,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,YAAY,GACZ,YAAY,CAAC;CAClB,CAmBA"}
+{"version":3,"file":"dtypes.d.ts","sourceRoot":"","sources":["../src/dtypes.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AAEH,yCAAyC;AACzC,MAAM,MAAM,YAAY,GACpB,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,CAAC;AAEd,oCAAoC;AACpC,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC,eAAO,MAAM,iBAAiB,IAAI,CAAC;AACnC,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,GACpB,YAAY,CAyCd;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,CAiBhE;AAED,8DAA8D;AAC9D,wBAAgB,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAY3D;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAY9D;AAED,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,aAAa,CAYlE;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,YAAY,GAClB;IACD,KAAK,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAC1D,UAAU,GACV,SAAS,GACT,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,YAAY,GACZ,YAAY,CAAC;CAClB,CAmBA"}

package/dist/dtypes.js

@@ -87,6 +87,40 @@ export function bytesPerElement(dtype) {
     };
     return map[dtype];
 }
+/**
+ * Map a Zarr v3 data_type string to an OME-XML pixel Type string.
+ * Reverse of omePixelTypeToZarr.
+ */
+export function zarrToOmePixelType(dtype) {
+    const map = {
+        int8: "int8",
+        int16: "int16",
+        int32: "int32",
+        uint8: "uint8",
+        uint16: "uint16",
+        uint32: "uint32",
+        float32: "float",
+        float64: "double",
+    };
+    return map[dtype];
+}
+/**
+ * Map a Zarr v3 data_type string to TIFF SampleFormat + BitsPerSample.
+ * Reverse of tiffDtypeToZarr.
+ */
+export function zarrToTiffDtype(dtype) {
+    const map = {
+        uint8: { sampleFormat: SAMPLE_FORMAT_UINT, bitsPerSample: 8 },
+        uint16: { sampleFormat: SAMPLE_FORMAT_UINT, bitsPerSample: 16 },
+        uint32: { sampleFormat: SAMPLE_FORMAT_UINT, bitsPerSample: 32 },
+        int8: { sampleFormat: SAMPLE_FORMAT_INT, bitsPerSample: 8 },
+        int16: { sampleFormat: SAMPLE_FORMAT_INT, bitsPerSample: 16 },
+        int32: { sampleFormat: SAMPLE_FORMAT_INT, bitsPerSample: 32 },
+        float32: { sampleFormat: SAMPLE_FORMAT_FLOAT, bitsPerSample: 32 },
+        float64: { sampleFormat: SAMPLE_FORMAT_FLOAT, bitsPerSample: 64 },
+    };
+    return map[dtype];
+}
 /**
  * Get the appropriate TypedArray constructor for a Zarr data_type.
  */

package/dist/dtypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"dtypes.js","sourceRoot":"","sources":["../src/dtypes.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,+BAA+B;AAyB/B,oCAAoC;AACpC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AACpC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AACnC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,YAAoB,EACpB,aAAqB;IAErB,IAAI,YAAY,KAAK,kBAAkB,EAAE,CAAC;QACxC,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,CAAC;gBACJ,OAAO,OAAO,CAAC;YACjB,KAAK,EAAE;gBACL,OAAO,QAAQ,CAAC;YAClB,KAAK,EAAE;gBACL,OAAO,QAAQ,CAAC;YAClB;gBACE,MAAM,IAAI,KAAK,CACb,2CAA2C,aAAa,EAAE,CAC3D,CAAC;QACN,CAAC;IACH,CAAC;SAAM,IAAI,YAAY,KAAK,iBAAiB,EAAE,CAAC;QAC9C,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,CAAC;gBACJ,OAAO,MAAM,CAAC;YAChB,KAAK,EAAE;gBACL,OAAO,OAAO,CAAC;YACjB,KAAK,EAAE;gBACL,OAAO,OAAO,CAAC;YACjB;gBACE,MAAM,IAAI,KAAK,CACb,yCAAyC,aAAa,EAAE,CACzD,CAAC;QACN,CAAC;IACH,CAAC;SAAM,IAAI,YAAY,KAAK,mBAAmB,EAAE,CAAC;QAChD,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,EAAE;gBACL,OAAO,SAAS,CAAC;YACnB,KAAK,EAAE;gBACL,OAAO,SAAS,CAAC;YACnB;gBACE,MAAM,IAAI,KAAK,CACb,yCAAyC,aAAa,EAAE,CACzD,CAAC;QACN,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,kCAAkC,YAAY,EAAE,CAAC,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IAChD,MAAM,GAAG,GAAiC;QACxC,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;QAChB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,SAAS;KAClB,CAAC;IACF,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IACpC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,+BAA+B,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,eAAe,CAAC,KAAmB;IACjD,MAAM,GAAG,GAAiC;QACxC,IAAI,EAAE,CAAC;QACP,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;QACT,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;KACX,CAAC;IACF,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,KAAmB;IAYnB,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,OAAO;YACV,OAAO,UAAU,CAAC;QACpB,KAAK,MAAM;YACT,OAAO,SAAS,CAAC;QACnB,KAAK,QAAQ;YACX,OAAO,WAAW,CAAC;QACrB,KAAK,OAAO;YACV,OAAO,UAAU,CAAC;QACpB,KAAK,QAAQ;YACX,OAAO,WAAW,CAAC;QACrB,KAAK,OAAO;YACV,OAAO,UAAU,CAAC;QACpB,KAAK,SAAS;YACZ,OAAO,YAAY,CAAC;QACtB,KAAK,SAAS;YACZ,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC"}
+{"version":3,"file":"dtypes.js","sourceRoot":"","sources":["../src/dtypes.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,+BAA+B;AAyB/B,oCAAoC;AACpC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AACpC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AACnC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,YAAoB,EACpB,aAAqB;IAErB,IAAI,YAAY,KAAK,kBAAkB,EAAE,CAAC;QACxC,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,CAAC;gBACJ,OAAO,OAAO,CAAC;YACjB,KAAK,EAAE;gBACL,OAAO,QAAQ,CAAC;YAClB,KAAK,EAAE;gBACL,OAAO,QAAQ,CAAC;YAClB;gBACE,MAAM,IAAI,KAAK,CACb,2CAA2C,aAAa,EAAE,CAC3D,CAAC;QACN,CAAC;IACH,CAAC;SAAM,IAAI,YAAY,KAAK,iBAAiB,EAAE,CAAC;QAC9C,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,CAAC;gBACJ,OAAO,MAAM,CAAC;YAChB,KAAK,EAAE;gBACL,OAAO,OAAO,CAAC;YACjB,KAAK,EAAE;gBACL,OAAO,OAAO,CAAC;YACjB;gBACE,MAAM,IAAI,KAAK,CACb,yCAAyC,aAAa,EAAE,CACzD,CAAC;QACN,CAAC;IACH,CAAC;SAAM,IAAI,YAAY,KAAK,mBAAmB,EAAE,CAAC;QAChD,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,EAAE;gBACL,OAAO,SAAS,CAAC;YACnB,KAAK,EAAE;gBACL,OAAO,SAAS,CAAC;YACnB;gBACE,MAAM,IAAI,KAAK,CACb,yCAAyC,aAAa,EAAE,CACzD,CAAC;QACN,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,kCAAkC,YAAY,EAAE,CAAC,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IAChD,MAAM,GAAG,GAAiC;QACxC,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;QAChB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,SAAS;KAClB,CAAC;IACF,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IACpC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,+BAA+B,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,eAAe,CAAC,KAAmB;IACjD,MAAM,GAAG,GAAiC;QACxC,IAAI,EAAE,CAAC;QACP,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;QACT,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;KACX,CAAC;IACF,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAmB;IACpD,MAAM,GAAG,GAAiC;QACxC,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,OAAO;QACd,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,QAAQ;KAClB,CAAC;IACF,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC;AAQD;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,KAAmB;IACjD,MAAM,GAAG,GAAwC;QAC/C,KAAK,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC,EAAE;QAC7D,MAAM,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,aAAa,EAAE,EAAE,EAAE;QAC/D,MAAM,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,aAAa,EAAE,EAAE,EAAE;QAC/D,IAAI,EAAE,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,CAAC,EAAE;QAC3D,KAAK,EAAE,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,EAAE,EAAE;QAC7D,KAAK,EAAE,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,EAAE,EAAE;QAC7D,OAAO,EAAE,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,EAAE,EAAE;QACjE,OAAO,EAAE,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,EAAE,EAAE;KAClE,CAAC;IACF,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,KAAmB;IAYnB,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,OAAO;YACV,OAAO,UAAU,CAAC;QACpB,KAAK,MAAM;YACT,OAAO,SAAS,CAAC;QACnB,KAAK,QAAQ;YACX,OAAO,WAAW,CAAC;QACrB,KAAK,OAAO;YACV,OAAO,UAAU,CAAC;QACpB,KAAK,QAAQ;YACX,OAAO,WAAW,CAAC;QACrB,KAAK,OAAO;YACV,OAAO,UAAU,CAAC;QACpB,KAAK,SAAS;YACZ,OAAO,YAAY,CAAC;QACtB,KAAK,SAAS;YACZ,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -20,7 +20,10 @@ export type { ZarrDataType } from "./dtypes.js";
 export type { OmeImage, OmePixels, OmeChannel, DimensionOrder } from "./ome-xml.js";
 export type { PyramidInfo, PlaneSelection } from "./ifd-indexer.js";
 export type { OmeAxis, OmeMultiscale, OmeDataset, OmeCoordinateTransformation, OmeroMetadata, OmeroChannel, ZarrGroupMetadata, ZarrArrayMetadata, } from "./metadata.js";
+export { toOmeTiff, type WriteOptions } from "./write.js";
+export { buildOmeXml, type OmeXmlWriterOptions, type DimensionInfo } from "./ome-xml-writer.js";
+export { buildTiff, makeImageTags, compressDeflate, type WritableIfd, type TiffTag, type BuildTiffOptions, } from "./tiff-writer.js";
 export { parseOmeXml, isOmeXml, getIfdIndex } from "./ome-xml.js";
-export { tiffDtypeToZarr, omePixelTypeToZarr, bytesPerElement } from "./dtypes.js";
+export { tiffDtypeToZarr, omePixelTypeToZarr, zarrToOmePixelType, zarrToTiffDtype, bytesPerElement, type TiffDtypeInfo, } from "./dtypes.js";
 export { parseStoreKey, computePixelWindow } from "./utils.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGnE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpF,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACpE,YAAY,EACV,OAAO,EACP,aAAa,EACb,UAAU,EACV,2BAA2B,EAC3B,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnF,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGnE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpF,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACpE,YAAY,EACV,OAAO,EACP,aAAa,EACb,UAAU,EACV,2BAA2B,EAC3B,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,SAAS,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,KAAK,mBAAmB,EAAE,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAChG,OAAO,EACL,SAAS,EACT,aAAa,EACb,eAAe,EACf,KAAK,WAAW,EAChB,KAAK,OAAO,EACZ,KAAK,gBAAgB,GACtB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,KAAK,aAAa,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -18,8 +18,12 @@
  * ```
  */
 export { TiffStore } from "./tiff-store.js";
+// Writer
+export { toOmeTiff } from "./write.js";
+export { buildOmeXml } from "./ome-xml-writer.js";
+export { buildTiff, makeImageTags, compressDeflate, } from "./tiff-writer.js";
 // Export utilities that may be useful
 export { parseOmeXml, isOmeXml, getIfdIndex } from "./ome-xml.js";
-export { tiffDtypeToZarr, omePixelTypeToZarr, bytesPerElement } from "./dtypes.js";
+export { tiffDtypeToZarr, omePixelTypeToZarr, zarrToOmePixelType, zarrToTiffDtype, bytesPerElement, } from "./dtypes.js";
 export { parseStoreKey, computePixelWindow } from "./utils.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,+BAA+B;AAE/B;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,SAAS,EAAyB,MAAM,iBAAiB,CAAC;AAiBnE,sCAAsC;AACtC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnF,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,+BAA+B;AAE/B;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,SAAS,EAAyB,MAAM,iBAAiB,CAAC;AAiBnE,SAAS;AACT,OAAO,EAAE,SAAS,EAAqB,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAgD,MAAM,qBAAqB,CAAC;AAChG,OAAO,EACL,SAAS,EACT,aAAa,EACb,eAAe,GAIhB,MAAM,kBAAkB,CAAC;AAE1B,sCAAsC;AACtC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,eAAe,GAEhB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/dist/ome-xml-writer.d.ts

@@ -0,0 +1,57 @@
+/**
+ * OME-XML writer: generates an OME-XML metadata string from an
+ * ngff-zarr Multiscales object.
+ *
+ * The generated XML follows the 2016-06 OME schema and embeds
+ * dimension sizes, pixel type, channel metadata, and physical
+ * sizes extracted from the Multiscales metadata.
+ */
+import type { Multiscales } from "@fideus-labs/ngff-zarr";
+import type { ZarrDataType } from "./dtypes.js";
+/** Options for OME-XML generation. */
+export interface OmeXmlWriterOptions {
+    /** DimensionOrder for the TIFF. Default: "XYZCT". */
+    dimensionOrder?: string;
+    /** Creator string embedded in the OME element. Default: "fiff". */
+    creator?: string;
+    /** Image name. Falls back to multiscales.metadata.name or "image". */
+    imageName?: string;
+}
+/** Extracted dimension info from a Multiscales object. */
+export interface DimensionInfo {
+    sizeX: number;
+    sizeY: number;
+    sizeZ: number;
+    sizeC: number;
+    sizeT: number;
+    physicalSizeX?: number;
+    physicalSizeY?: number;
+    physicalSizeZ?: number;
+    physicalSizeXUnit?: string;
+    physicalSizeYUnit?: string;
+    physicalSizeZUnit?: string;
+}
+/**
+ * Generate an OME-XML metadata string from a Multiscales object.
+ *
+ * @param multiscales - The ngff-zarr Multiscales to generate XML for.
+ * @param dtype - The Zarr data type of the pixel data.
+ * @param options - Writer options.
+ * @returns A complete OME-XML string suitable for a TIFF ImageDescription tag.
+ */
+export declare function buildOmeXml(multiscales: Multiscales, dtype: ZarrDataType, options?: OmeXmlWriterOptions): string;
+/**
+ * Extract dimension sizes and physical sizes from a Multiscales object.
+ * Uses the highest-resolution image (images[0]).
+ */
+export declare function extractDimensions(multiscales: Multiscales): DimensionInfo;
+/**
+ * Convert a 6-digit hex color string (e.g. "FF0000") to a signed 32-bit RGBA int.
+ * Alpha defaults to 0xFF.
+ */
+export declare function hexColorToOmeInt(hex: string): number;
+/**
+ * Convert an OME signed 32-bit RGBA int to a 6-digit hex color string.
+ */
+export declare function omeIntToHexColor(value: number): string;
+//# sourceMappingURL=ome-xml-writer.d.ts.map

package/dist/ome-xml-writer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ome-xml-writer.d.ts","sourceRoot":"","sources":["../src/ome-xml-writer.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAGhD,sCAAsC;AACtC,MAAM,WAAW,mBAAmB;IAClC,qDAAqD;IACrD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,0DAA0D;AAC1D,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,WAAW,EAAE,WAAW,EACxB,KAAK,EAAE,YAAY,EACnB,OAAO,GAAE,mBAAwB,GAChC,MAAM,CAuBR;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,aAAa,CA2DzE;AAyDD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAapD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAUtD"}