Package qupath.lib.images.servers

Class WrappedBufferedImageServer

java.lang.Object

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

qupath.lib.images.servers.AbstractTileableImageServer

qupath.lib.images.servers.WrappedBufferedImageServer

All Implemented Interfaces:

AutoCloseable, ImageServer<BufferedImage>

public class WrappedBufferedImageServer
extends AbstractTileableImageServer

Implementation of an ImageServer that simply wraps an existing BufferedImage.

This may help whenever requiring a server, but only having a BufferedImage.

Constructor Summary

Constructors

Constructor	Description
WrappedBufferedImageServer(String imageName, BufferedImage img)	Create an ImageServer<BufferedImage> using an image that has been provided directly.
WrappedBufferedImageServer(String imageName, BufferedImage img, List<ImageChannel> channels)	Create an ImageServer<BufferedImage> using an image that has been provided directly.

Method Summary

Modifier and Type	Method	Description
protected String	createID()	Returns a UUID.
protected ImageServerBuilder.ServerBuilder<BufferedImage>	createServerBuilder()	Returns null (does not support ServerBuilders).
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 BufferedImage	readTile(TileRequest tileRequest)	Read a single image tile.

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

allowSmoothInterpolation, createDefaultRGBImage, getDefaultColorModel, getEmptyTile, getEmptyTile, getTile, readRegion

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

close, 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

getPixelCalibration, readBufferedImage, readRegion, readRegion

Constructor Details

WrappedBufferedImageServer

public WrappedBufferedImageServer(String imageName,
 BufferedImage img)

Create an ImageServer<BufferedImage> using an image that has been provided directly.

Parameters:

imageName - a name to display (may be null)

img - the BufferedImage to wrap

WrappedBufferedImageServer

public WrappedBufferedImageServer(String imageName,
 BufferedImage img,
 List<ImageChannel> channels)

Create an ImageServer<BufferedImage> using an image that has been provided directly.

Parameters:

imageName - a name to display (may be null)

img - the BufferedImage to wrap

channels - the ImageChannels, required in case the preferred channel colors cannot be obtained from the image itself

Method Details

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().

Returns:

createID

protected String createID()

Returns a UUID.

Specified by:

createID in class AbstractImageServer<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...)

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.

Returns:

See Also:

• ImageServer.getMetadata()

createServerBuilder

protected ImageServerBuilder.ServerBuilder<BufferedImage> createServerBuilder()

Returns null (does not support ServerBuilders).

Specified by:

createServerBuilder in class AbstractImageServer<BufferedImage>

Returns:

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