Package qupath.lib.images.servers

Class ImageServers

java.lang.Object

qupath.lib.images.servers.ImageServers

public class ImageServers
extends Object

Helper class for working with ImageServer objects.

The main use is to convert ImageServers to and from serialized representations for use within a Project.

Author:

Pete Bankhead

Constructor Summary

Constructors

Constructor	Description
ImageServers()

Method Summary

Modifier and Type	Method	Description
static ImageServer<BufferedImage>	buildServer(String path, String... args)	Build a ImageServer for the specified URI path and optional args.
static ImageServer<BufferedImage>	buildServer(URI uri, String... args)	Build a ImageServer for the specified URI and optional args.
static List<ImageServerBuilder.UriImageSupport<BufferedImage>>	getAllImageSupports(URI uri, String... args)	Get all ImageServerBuilder.UriImageSupport that claim to be able to open the specified URI with optional args.
static TypeAdapterFactory	getImageServerTypeAdapterFactory(boolean includeMetadata)	Get a TypeAdapterFactory for ImageServers, optionally including metadata in the serialized form of the server.
static ImageServerBuilder.UriImageSupport<BufferedImage>	getImageSupport(URI uri, String... args)	Get the ImageServerBuilder.UriImageSupport that is best able to open the specified image with optional args.
static ImageServerBuilder.UriImageSupport<BufferedImage>	getImageSupport(ImageServerBuilder<BufferedImage> builder, URI uri, String... args)	Get the ImageServerBuilder.UriImageSupport associated with an ImageServerBuilder, or null if the builder does not support the image.
static TypeAdapterFactory	getServerBuilderFactory()	Get a TypeAdapterFactory to handle ServerBuilders.
static ImageServer<BufferedImage>	pyramidalize(ImageServer<BufferedImage> server, double... downsamples)	Wrap an ImageServer to dynamically generate a pyramid.
static ImageServer<BufferedImage>	pyramidalizeTiled(ImageServer<BufferedImage> server, int tileWidth, int tileHeight, double... downsamples)	Wrap an ImageServer to dynamically generate a pyramid, using specified tile sizes.

Methods inherited from class java.lang.Object

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

Constructor Details

ImageServers

public ImageServers()

Method Details

getServerBuilderFactory

public static TypeAdapterFactory getServerBuilderFactory()

Get a TypeAdapterFactory to handle ServerBuilders.

Returns:

pyramidalize

public static ImageServer<BufferedImage> pyramidalize(ImageServer<BufferedImage> server,
 double... downsamples)

Wrap an ImageServer to dynamically generate a pyramid. This does not involve writing any new image, and may be rather processor and memory-intensive as high-resolution tiles must be accessed to fulfil low-resolution requests. However, tile caching means that after tiles have been accessed once perceived performance can be considerably improved.

Parameters:

server - the server to wrap (typically having only one resolution level)

downsamples - optional array giving the downsamples of the new pyramid. If not provided,

Returns:

pyramidalizeTiled

public static ImageServer<BufferedImage> pyramidalizeTiled(ImageServer<BufferedImage> server,
 int tileWidth,
 int tileHeight,
 double... downsamples)

Wrap an ImageServer to dynamically generate a pyramid, using specified tile sizes. This does not involve writing any new image, and may be rather processor and memory-intensive as high-resolution tiles must be accessed to fulfil low-resolution requests. However, tile caching means that after tiles have been accessed once perceived performance can be considerably improved.

Parameters:

server - the server to wrap (typically having only one resolution level)

tileWidth - requested tile height

tileHeight - requested tile height

downsamples - optional array giving the downsamples of the new pyramid. If not provided,

Returns:

buildServer

public static ImageServer<BufferedImage> buildServer(String path,
 String... args)
                                              throws IOException

Build a ImageServer for the specified URI path and optional args.

See buildServer(URI, String...) for more information about how args are applied.

Parameters:

path - path for the image; it should be possible to convert this to a URI

args -

Returns:

Throws:

IOException

buildServer

public static ImageServer<BufferedImage> buildServer(URI uri,
 String... args)
                                              throws IOException

Build a ImageServer for the specified URI and optional args. This differs from ImageServerProvider.buildServer(String, Class, String...) in two main ways:

1. it always uses BufferedImage as the server class
2. where possible, args that request a transformed server are applied

Supported arguments include

1. --classname to request an image provider class
2. --order RGB/BGR etc. to request reordering for RGB channels
3. --rotate ROTATE_90/ROTATE_180/ROTATE_270 to request rotation

More arguments are likely to be added in future versions. All unmatched arguments are passed to the image reading library.

Parameters:

uri -

args -

Returns:

Throws:

IOException

getAllImageSupports

public static List<ImageServerBuilder.UriImageSupport<BufferedImage>> getAllImageSupports(URI uri,
 String... args)
                                                                                   throws IOException

Get all ImageServerBuilder.UriImageSupport that claim to be able to open the specified URI with optional args.

See buildServer(URI, String...) for more information about how args are applied.

Parameters:

uri -

args -

Returns:

a list or ImageServerBuilder.UriImageSupport, ranked in descending order of support level.

Throws:

IOException

getImageSupport

public static ImageServerBuilder.UriImageSupport<BufferedImage> getImageSupport(URI uri,
 String... args)
                                                                         throws IOException

Get the ImageServerBuilder.UriImageSupport that is best able to open the specified image with optional args.

See buildServer(URI, String...) for more information about how args are applied.

Parameters:

uri -

args -

Returns:

a list or ImageServerBuilder.UriImageSupport, ranked in descending order of support level.

Throws:

IOException

getImageSupport

public static ImageServerBuilder.UriImageSupport<BufferedImage> getImageSupport(ImageServerBuilder<BufferedImage> builder,
 URI uri,
 String... args)
                                                                         throws IOException

Get the ImageServerBuilder.UriImageSupport associated with an ImageServerBuilder, or null if the builder does not support the image.

See buildServer(URI, String...) for more information about how args are applied.

Parameters:

builder -

uri -

args -

Returns:

Throws:

IOException

getImageServerTypeAdapterFactory

public static TypeAdapterFactory getImageServerTypeAdapterFactory(boolean includeMetadata)

Get a TypeAdapterFactory for ImageServers, optionally including metadata in the serialized form of the server.

Parameters:

includeMetadata -

Returns: