Package qupath.lib.images.writers.ome

Class OMETiffWriter

java.lang.Object

qupath.lib.images.writers.ome.OMETiffWriter

All Implemented Interfaces:

ImageWriter<BufferedImage>

public class OMETiffWriter
extends Object
implements ImageWriter<BufferedImage>

ImageWriter for writing OME-TIFF images. For greater control, see OMEPyramidWriter.

Author:

Pete Bankhead

Constructor Summary

Constructors

Constructor	Description
OMETiffWriter()

Method Summary

Modifier and Type	Method	Description
String	getDetails()	Get further details of the writer, which may be displayed to a user.
Collection<String>	getExtensions()	Get the file extensions used by the image writer.
Class<BufferedImage>	getImageClass()	Get the class of supported images.
String	getName()	Get the name of the image writer.
boolean	supportsImageType(ImageServer<BufferedImage> server)	Test whether images provided by a specified ImageServer can be successfully written.
boolean	supportsPixelSize()	Returns true if the writer is capable of storing pixel size information.
boolean	supportsPyramidal()	Returns true if the writer is capable of writing pyramidal images.
boolean	supportsRGB()	Check if writer can handle RGB (it probably can...).
boolean	supportsT()	Check if writer can handle multiple timepoints.
boolean	supportsZ()	Check if writer can handle multiple z-slices.
void	writeImage(BufferedImage img, OutputStream stream)	Write a full image to a specified output stream.
void	writeImage(BufferedImage img, String pathOutput)	Write a full image to a specified path.
void	writeImage(ImageServer<BufferedImage> server, OutputStream stream)	Write OME-TIFF image to an output stream.
void	writeImage(ImageServer<BufferedImage> server, String pathOutput)	Write a full image to a specified path.
void	writeImage(ImageServer<BufferedImage> server, RegionRequest region, OutputStream stream)	Write OME-TIFF image to an output stream.
void	writeImage(ImageServer<BufferedImage> server, RegionRequest region, String pathOutput)	Write an image region to a specified path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface qupath.lib.images.writers.ImageWriter

getDefaultExtension

Constructor Details

OMETiffWriter

public OMETiffWriter()

Method Details

getName

public String getName()

Description copied from interface: ImageWriter

Get the name of the image writer.

Specified by:

getName in interface ImageWriter<BufferedImage>

Returns:

getExtensions

public Collection<String> getExtensions()

Description copied from interface: ImageWriter

Get the file extensions used by the image writer. These are returned without the leading 'dot'. In the case where multiple extensions are associated with a file type (e.g. "jpg", "jpeg", "tif", "tiff") the preferred should be returned first;

Specified by:

getExtensions in interface ImageWriter<BufferedImage>

Returns:

supportsT

public boolean supportsT()

Description copied from interface: ImageWriter

Check if writer can handle multiple timepoints.

Specified by:

supportsT in interface ImageWriter<BufferedImage>

Returns:

supportsZ

public boolean supportsZ()

Description copied from interface: ImageWriter

Check if writer can handle multiple z-slices.

Specified by:

supportsZ in interface ImageWriter<BufferedImage>

Returns:

supportsRGB

public boolean supportsRGB()

Description copied from interface: ImageWriter

Check if writer can handle RGB (it probably can...).

Specified by:

supportsRGB in interface ImageWriter<BufferedImage>

Returns:

supportsImageType

public boolean supportsImageType(ImageServer<BufferedImage> server)

Description copied from interface: ImageWriter

Test whether images provided by a specified ImageServer can be successfully written.

Reasons why it might not be are the number of channels and/or bit-depth.

Specified by:

supportsImageType in interface ImageWriter<BufferedImage>

Parameters:

server -

Returns:

supportsPyramidal

public boolean supportsPyramidal()

Description copied from interface: ImageWriter

Returns true if the writer is capable of writing pyramidal images.

Specified by:

supportsPyramidal in interface ImageWriter<BufferedImage>

Returns:

supportsPixelSize

public boolean supportsPixelSize()

Description copied from interface: ImageWriter

Returns true if the writer is capable of storing pixel size information.

Specified by:

supportsPixelSize in interface ImageWriter<BufferedImage>

Returns:

getDetails

public String getDetails()

Description copied from interface: ImageWriter

Get further details of the writer, which may be displayed to a user.

Specified by:

getDetails in interface ImageWriter<BufferedImage>

Returns:

getImageClass

public Class<BufferedImage> getImageClass()

Description copied from interface: ImageWriter

Get the class of supported images.

Specified by:

getImageClass in interface ImageWriter<BufferedImage>

Returns:

ImageServer.getImageClass()

writeImage

public void writeImage(ImageServer<BufferedImage> server,
 RegionRequest region,
 String pathOutput)
                throws IOException

Description copied from interface: ImageWriter

Write an image region to a specified path.

Specified by:

writeImage in interface ImageWriter<BufferedImage>

Parameters:

server -

region -

pathOutput -

Throws:

IOException

writeImage

public void writeImage(BufferedImage img,
 String pathOutput)
                throws IOException

Description copied from interface: ImageWriter

Write a full image to a specified path.

Specified by:

writeImage in interface ImageWriter<BufferedImage>

Parameters:

img -

pathOutput -

Throws:

IOException

writeImage

public void writeImage(ImageServer<BufferedImage> server,
 String pathOutput)
                throws IOException

Description copied from interface: ImageWriter

Write a full image to a specified path.

Specified by:

writeImage in interface ImageWriter<BufferedImage>

Parameters:

server -

pathOutput -

Throws:

IOException

writeImage

public void writeImage(ImageServer<BufferedImage> server,
 RegionRequest region,
 OutputStream stream)
                throws IOException

Write OME-TIFF image to an output stream. Note that this must be able to write the image in-memory first, and therefore is not suitable for very large images.

Specified by:

writeImage in interface ImageWriter<BufferedImage>

Parameters:

server -

region -

stream -

Throws:

IOException

writeImage

public void writeImage(BufferedImage img,
 OutputStream stream)
                throws IOException

Description copied from interface: ImageWriter

Write a full image to a specified output stream.

Specified by:

writeImage in interface ImageWriter<BufferedImage>

Parameters:

img -

stream -

Throws:

IOException

writeImage

public void writeImage(ImageServer<BufferedImage> server,
 OutputStream stream)
                throws IOException

Write OME-TIFF image to an output stream. Note that this must be able to write the image in-memory first, and therefore is not suitable for very large images.

Specified by:

writeImage in interface ImageWriter<BufferedImage>

Parameters:

server -

stream -

Throws:

IOException