Class PyramidalOMEZarrWriter

java.lang.Object

qupath.lib.images.writers.ome.zarr.PyramidalOMEZarrWriter

public class PyramidalOMEZarrWriter
extends Object

An OME-Zarr file writer as described by version 0.4 of the specifications of the Next-generation file formats (NGFF). The transitional "bioformats2raw.layout" and "omero" metadata are also considered.

Contrary to OMEZarrWriter, this class will first write the full resolution level. Then, the second level is written by looking at the first level pixels that were just written (so the input image is not considered anymore). Then, the third level is written by looking at the second level pixels that were just written, and so on until all levels are written. This provides less flexibility than OMEZarrWriter but is less likely to throw out of memory errors.

Use a PyramidalOMEZarrWriter.Builder to create an instance of this class.

This class is not thread-safe but already uses concurrency internally to write tiles.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PyramidalOMEZarrWriter.Builder	Builder to create an instance of a PyramidalOMEZarrWriter.

Method Summary

Modifier and Type	Method	Description
void	writeImage()	Write the image level by level as described in PyramidalOMEZarrWriter.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

writeImage

public void writeImage()
                throws Exception

Write the image level by level as described in PyramidalOMEZarrWriter. This function will block until all levels are written.

Throws:

Exception - if a reading or writing error occurs or if this function is interrupted