Package qupath.lib.gui.images.servers

Class RenderedImageServer.Builder

java.lang.Object

qupath.lib.gui.images.servers.RenderedImageServer.Builder

Enclosing class:

RenderedImageServer

public static class RenderedImageServer.Builder
extends Object

Builder to create an ImageServer to display rendered images, with optional overlay layers. This provides more fine-grained control of how the rendering is performed than RenderedImageServer.createRenderedServer(QuPathViewer).

Constructor Summary

Constructors

Constructor	Description
Builder(QuPathViewer viewer)	Create a rendered image server build using viewer defaults.
Builder(ImageData<BufferedImage> imageData)	Create a rendered image server for the specified ImageData;

Method Summary

Modifier and Type	Method	Description
RenderedImageServer.Builder	backgroundColor(int rgb, boolean keepAlpha)	Specify a base color.
RenderedImageServer.Builder	backgroundColor(Color color)	Specify a base color.
ImageServer<BufferedImage>	build()	Create the rendered image server.
RenderedImageServer.Builder	display(ImageDisplay display)	Deprecated. use renderer(ImageRenderer) instead (since an ImageDisplay is also an ImageRenderer.
RenderedImageServer.Builder	downsamples(double... downsamples)	Specify downsamples; this is especially important for 'thick' objects (annotations, TMA cores) because the downsamples define the resolutions at which these will be rendered.
RenderedImageServer.Builder	layers(Collection<PathOverlay> layers)	Specify one or more overlay layers as a collection.
RenderedImageServer.Builder	layers(PathOverlay... layers)	Specify one or more overlay layers.
RenderedImageServer.Builder	overlayOpacity(double opacity)	Specify the opacity for overlay layers.
RenderedImageServer.Builder	renderer(ImageRenderer renderer)	Specify the ImageRenderer that controls conversion to RGB.
RenderedImageServer.Builder	settings(ImageDisplaySettings settings)	Specify the ImageDisplaySettings that control conversion to RGB.
RenderedImageServer.Builder	store(DefaultImageRegionStore store)	Specify the region store used to paint the underlying image.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(QuPathViewer viewer)

Create a rendered image server build using viewer defaults.

Parameters:

viewer -

Builder

public Builder(ImageData<BufferedImage> imageData)

Create a rendered image server for the specified ImageData;

Parameters:

imageData -

Method Details

downsamples

public RenderedImageServer.Builder downsamples(double... downsamples)

Specify downsamples; this is especially important for 'thick' objects (annotations, TMA cores) because the downsamples define the resolutions at which these will be rendered.

Parameters:

downsamples -

Returns:

display

@Deprecated
public RenderedImageServer.Builder display(ImageDisplay display)

Deprecated.

use renderer(ImageRenderer) instead (since an ImageDisplay is also an ImageRenderer.

Specify the ImageDisplay that controls conversion to RGB.

Parameters:

display -

Returns:

settings

public RenderedImageServer.Builder settings(ImageDisplaySettings settings)

Specify the ImageDisplaySettings that control conversion to RGB. This will only be applied if no renderer has been set.

Parameters:

settings -

Returns:

Since:

v0.5.0

See Also:

• renderer(ImageRenderer)

renderer

public RenderedImageServer.Builder renderer(ImageRenderer renderer)

Specify the ImageRenderer that controls conversion to RGB.

Parameters:

renderer -

Returns:

See Also:

• settings(ImageDisplaySettings)

overlayOpacity

public RenderedImageServer.Builder overlayOpacity(double opacity)

Specify the opacity for overlay layers. This will be clipped to the range 0 (transparent) and 1 (opaque).

Parameters:

opacity -

Returns:

layers

public RenderedImageServer.Builder layers(PathOverlay... layers)

Specify one or more overlay layers.

Parameters:

layers -

Returns:

layers

public RenderedImageServer.Builder layers(Collection<PathOverlay> layers)

Specify one or more overlay layers as a collection.

Parameters:

layers -

Returns:

store

public RenderedImageServer.Builder store(DefaultImageRegionStore store)

Specify the region store used to paint the underlying image.

Parameters:

store -

Returns:

backgroundColor

public RenderedImageServer.Builder backgroundColor(Color color)

Specify a base color. This is useful if transparent overlays or renderers will be used.

Parameters:

color -

Returns:

backgroundColor

public RenderedImageServer.Builder backgroundColor(int rgb,
 boolean keepAlpha)

Specify a base color. This is useful if transparent overlays or renderers will be used.

Parameters:

rgb - packed (A)RGB version of the color

keepAlpha - true if the packed color contains an alpha value

Returns:

build

public ImageServer<BufferedImage> build()
                                 throws IOException

Create the rendered image server.

Returns:

Throws:

IOException