Package qupath.lib.gui.images.servers

Class RenderedImageServer

java.lang.Object

qupath.lib.images.servers.AbstractImageServer<BufferedImage>

qupath.lib.images.servers.AbstractTileableImageServer

qupath.lib.gui.images.servers.RenderedImageServer

All Implemented Interfaces:

AutoCloseable, GeneratingImageServer<BufferedImage>, ImageServer<BufferedImage>

public class RenderedImageServer
extends AbstractTileableImageServer
implements GeneratingImageServer<BufferedImage>

An ImageServer that can display a rendered image, with optional overlays. This is intended for use when exporting 'flattened' RGB images.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderedImageServer.Builder	Builder to create an ImageServer to display rendered images, with optional overlay layers.

Method Summary

Modifier and Type	Method	Description
void	close()
protected BufferedImage	createDefaultRGBImage(int width, int height)	Create the default (blank) RGB image for this server.
protected String	createID()	Create a unique ID for the server, which can be returned as the default value of AbstractImageServer.getPath().
static ImageServer<BufferedImage>	createRenderedServer(QuPathViewer viewer)	Create an ImageServer that returns tiles based on how approximately they would appear within the viewer.
static ImageServer<BufferedImage>	createRenderedServer(ImageServer<BufferedImage> server, ImageRenderer renderer)	Create an ImageServer that converts the image to RGB using the specified ImageRenderer.
protected ImageServerBuilder.ServerBuilder<BufferedImage>	createServerBuilder()	Create a ServerBuilder, which can be used to construct an identical ImageServer.
ImageServerMetadata	getOriginalMetadata()	Get the original metadata read during creation of the server.
String	getServerType()	A string describing the type of server, for example the name of the library used (Openslide, Bioformats...)
Collection<URI>	getURIs()	Get the URIs for images required for this server.
protected boolean	hasAlpha()
protected BufferedImage	readTile(TileRequest tileRequest)	Read a single image tile.

Methods inherited from class qupath.lib.images.servers.AbstractTileableImageServer

allowSmoothInterpolation, getDefaultColorModel, getEmptyTile, getEmptyTile, getTile, readRegion

Methods inherited from class qupath.lib.images.servers.AbstractImageServer

getAssociatedImage, getAssociatedImageList, getBuilder, getCache, getCachedTile, getChannel, getDefaultThumbnail, getDownsampleForResolution, getHeight, getImageClass, getMetadata, getPath, getPixelType, getPreferredDownsamples, getThumbnailDownsampleFactor, getTileRequestManager, getWidth, isEmptyRegion, isRGB, nChannels, nResolutions, nTimepoints, nZSlices, setMetadata, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface qupath.lib.images.servers.ImageServer

getAssociatedImage, getAssociatedImageList, getBuilder, getCachedTile, getChannel, getDefaultThumbnail, getDownsampleForResolution, getHeight, getImageClass, getMetadata, getPath, getPixelCalibration, getPixelType, getPreferredDownsamples, getTileRequestManager, getWidth, isEmptyRegion, isRGB, nChannels, nResolutions, nTimepoints, nZSlices, readBufferedImage, readRegion, readRegion, readRegion, setMetadata

Method Details

createRenderedServer

public static ImageServer<BufferedImage> createRenderedServer(QuPathViewer viewer)
                                                       throws IOException

Create an ImageServer that returns tiles based on how approximately they would appear within the viewer. Note that

• the server uses fixed downsample values, while the viewer can adapt annotation line thickness continuously - therefore the agreement is not exact
• changing display settings in the viewer may impact how later tiles are rendered
• the server cannot be serialized to JSON

The intention is to treat this as a throwaway server used to create rendered images including color transforms and overlays, which will be saved to disk.

Parameters:

viewer -

Returns:

Throws:

IOException

See Also:

• RenderedImageServer.Builder

createRenderedServer

public static ImageServer<BufferedImage> createRenderedServer(ImageServer<BufferedImage> server,
 ImageRenderer renderer)
                                                       throws IOException

Create an ImageServer that converts the image to RGB using the specified ImageRenderer.

Parameters:

server -

renderer -

Returns:

Throws:

IOException

getURIs

public Collection<URI> getURIs()

Description copied from interface: ImageServer

Get the URIs for images required for this server. In the simplest case, this is a singleton list returning a URI representing a local file. However, some ImageServers may not have an associated URI at all, whereas others may depend upon multiple URIs (e.g. if concatenating images).

Note: A URI alone may not be sufficient to recreate even a simple ImageServer; see ImageServer.getBuilder().

Specified by:

getURIs in interface ImageServer<BufferedImage>

Returns:

getServerType

public String getServerType()

Description copied from interface: ImageServer

A string describing the type of server, for example the name of the library used (Openslide, Bioformats...)

Specified by:

getServerType in interface ImageServer<BufferedImage>

Returns:

getOriginalMetadata

public ImageServerMetadata getOriginalMetadata()

Description copied from interface: ImageServer

Get the original metadata read during creation of the server. This may or may not be correct.

Specified by:

getOriginalMetadata in interface ImageServer<BufferedImage>

Returns:

See Also:

• ImageServer.getMetadata()

readTile

protected BufferedImage readTile(TileRequest tileRequest)
                          throws IOException

Description copied from class: AbstractTileableImageServer

Read a single image tile.

Specified by:

readTile in class AbstractTileableImageServer

Parameters:

tileRequest -

Returns:

Throws:

IOException

hasAlpha

protected boolean hasAlpha()

createDefaultRGBImage

protected BufferedImage createDefaultRGBImage(int width,
 int height)

Description copied from class: AbstractTileableImageServer

Create the default (blank) RGB image for this server.

By default this will have TYPE_INT_RGB but a subclass may change this if necessary (e.g. to incorporate an alpha channel).

Overrides:

createDefaultRGBImage in class AbstractTileableImageServer

Parameters:

width -

height -

Returns:

createServerBuilder

protected ImageServerBuilder.ServerBuilder<BufferedImage> createServerBuilder()

Description copied from class: AbstractImageServer

Create a ServerBuilder, which can be used to construct an identical ImageServer. This should also include the current metadata. It is permissible to return null for an ImageServer that cannot be recreated via a ImageServerBuilder.ServerBuilder.

Specified by:

createServerBuilder in class AbstractImageServer<BufferedImage>

Returns:

createID

protected String createID()

Description copied from class: AbstractImageServer

Create a unique ID for the server, which can be returned as the default value of AbstractImageServer.getPath(). A suggested implementation is

  getClass().getName() + ": " + URI + parameters
 

This will be called on demand whenever AbstractImageServer.getPath() is first required.

Specified by:

createID in class AbstractImageServer<BufferedImage>

Returns:

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractImageServer<BufferedImage>

Throws:

Exception