Package qupath.lib.images.servers

Class ImageServerMetadata.Builder

java.lang.Object

qupath.lib.images.servers.ImageServerMetadata.Builder

Enclosing class:

ImageServerMetadata

public static class ImageServerMetadata.Builder
extends Object

Builder to create a new ImageServerMetadata object.

Constructor Summary

Constructors

Constructor	Description
Builder()	Minimal builder for a new ImageServerMetadata; further properties must be set.
Builder(Class<? extends ImageServer<?>> serverClass, String path, int width, int height)	Builder for a new ImageServerMetadata; further properties must be set.
Builder(ImageServerMetadata metadata)	Builder for a new ImageServerMetadata object that takes an existing metadata object as a starting point, but allows individual properties to be overridden.

Method Summary

Modifier and Type	Method	Description
ImageServerMetadata	build()	Build an ImageServerMetadata.
ImageServerMetadata.Builder	channels(Collection<ImageChannel> channels)	Specify the image channels.
ImageServerMetadata.Builder	channelType(ImageServerMetadata.ChannelType type)	Specify the interpretation of channels.
ImageServerMetadata.Builder	classificationLabels(Map<Integer,PathClass> classificationLabels)	Specify the interpretation of classification labels.
ImageServerMetadata.Builder	height(int height)	Specify the full-resolution image height.
ImageServerMetadata.Builder	levels(Collection<ImageServerMetadata.ImageResolutionLevel> levels)	Specify resolution levels, where the largest image should come first.
ImageServerMetadata.Builder	levelsFromDownsamples(double... downsamples)	Specify downsample values for pyramidal levels.
ImageServerMetadata.Builder	magnification(double magnification)	Specify a magnification value for the highest-resolution image.
ImageServerMetadata.Builder	maxValue(Number val)	Specify the maximum value supported by this image.
ImageServerMetadata.Builder	minValue(Number val)	Specify the minimum value supported by this image.
ImageServerMetadata.Builder	name(String name)	Specify the image name.
ImageServerMetadata.Builder	pixelSizeMicrons(Number pixelWidthMicrons, Number pixelHeightMicrons)	Specify the pixel sizes, in microns.
ImageServerMetadata.Builder	pixelType(PixelType pixelType)	Specify the bit-depth of the image.
ImageServerMetadata.Builder	preferredTileSize(int tileWidth, int tileHeight)	Specify the preferred tile height and width.
ImageServerMetadata.Builder	rgb(boolean isRGB)	Specify that the image stores pixels in (A)RGB form.
ImageServerMetadata.Builder	sizeT(int sizeT)	Specify the number of time points.
ImageServerMetadata.Builder	sizeZ(int sizeZ)	Specify the number of z-slices.
ImageServerMetadata.Builder	timepoints(TimeUnit timeUnit, double... timepoints)	Specify the time unit and individual time points.
ImageServerMetadata.Builder	width(int width)	Specify the full-resolution image width.
ImageServerMetadata.Builder	zSpacingMicrons(Number zSpacingMicrons)	Specify the spacing between z-slices, in microns.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(ImageServerMetadata metadata)

Builder for a new ImageServerMetadata object that takes an existing metadata object as a starting point, but allows individual properties to be overridden.

The existing metadata will be duplicated, therefore later changes in one metadata object will not be reflected in the other.

Parameters:

metadata -

Builder

public Builder()

Minimal builder for a new ImageServerMetadata; further properties must be set.

Builder

public Builder(Class<? extends ImageServer<?>> serverClass,
 String path,
 int width,
 int height)

Builder for a new ImageServerMetadata; further properties must be set.

Parameters:

serverClass -

path -

width -

height -

Method Details

width

public ImageServerMetadata.Builder width(int width)

Specify the full-resolution image width.

Parameters:

width -

Returns:

height

public ImageServerMetadata.Builder height(int height)

Specify the full-resolution image height.

Parameters:

height -

Returns:

minValue

public ImageServerMetadata.Builder minValue(Number val)

Specify the minimum value supported by this image. If not provided, this will be taken from the PixelType.

Parameters:

val -

Returns:

See Also:

• pixelType(PixelType)

maxValue

public ImageServerMetadata.Builder maxValue(Number val)

Specify the maximum value supported by this image. If not provided, this will be taken from the PixelType. This purpose of this method is to support other effective bit-depths (e.g. 12-bit, 14-bit).

Parameters:

val -

Returns:

See Also:

• pixelType(PixelType)

channelType

public ImageServerMetadata.Builder channelType(ImageServerMetadata.ChannelType type)

Specify the interpretation of channels. If this is ImageServerMetadata.ChannelType.CLASSIFICATION it will also set the channels to be the default for this kind of server, i.e. a single channel with ImageServerMetadata.DEFAULT_CLASSIFICATION_LABELS_CHANNEL.

Parameters:

type -

Returns:

classificationLabels

public ImageServerMetadata.Builder classificationLabels(Map<Integer,PathClass> classificationLabels)

Specify the interpretation of classification labels. Only relevant for ImageServerMetadata.ChannelType.CLASSIFICATION.

Parameters:

classificationLabels -

Returns:

rgb

public ImageServerMetadata.Builder rgb(boolean isRGB)

Specify that the image stores pixels in (A)RGB form.

Parameters:

isRGB -

Returns:

pixelType

public ImageServerMetadata.Builder pixelType(PixelType pixelType)

Specify the bit-depth of the image.

Parameters:

pixelType -

Returns:

levelsFromDownsamples

public ImageServerMetadata.Builder levelsFromDownsamples(double... downsamples)

Specify downsample values for pyramidal levels. The appropriate image sizes will be computed based upon these.

Parameters:

downsamples -

Returns:

See Also:

• levels(Collection)

levels

public ImageServerMetadata.Builder levels(Collection<ImageServerMetadata.ImageResolutionLevel> levels)

Specify resolution levels, where the largest image should come first.

Normally level[0].width == width && level[0].height == height, but this is not strictly required; for example, it is permissible for the server to supply only resolutions lower than the full image if these ought to be upsampled elsewhere.

In other words, the width and height encode the size of the image as it should be interpreted, while the levels refer to the size of the rasters actually available here.

Parameters:

levels -

Returns:

sizeZ

public ImageServerMetadata.Builder sizeZ(int sizeZ)

Specify the number of z-slices.

Parameters:

sizeZ -

Returns:

sizeT

public ImageServerMetadata.Builder sizeT(int sizeT)

Specify the number of time points.

Parameters:

sizeT -

Returns:

pixelSizeMicrons

public ImageServerMetadata.Builder pixelSizeMicrons(Number pixelWidthMicrons,
 Number pixelHeightMicrons)

Specify the pixel sizes, in microns.

Parameters:

pixelWidthMicrons -

pixelHeightMicrons -

Returns:

zSpacingMicrons

public ImageServerMetadata.Builder zSpacingMicrons(Number zSpacingMicrons)

Specify the spacing between z-slices, in microns.

Parameters:

zSpacingMicrons -

Returns:

timepoints

public ImageServerMetadata.Builder timepoints(TimeUnit timeUnit,
 double... timepoints)

Specify the time unit and individual time points.

Parameters:

timeUnit -

timepoints - time points, defined in terms of timeUnits.

Returns:

magnification

public ImageServerMetadata.Builder magnification(double magnification)

Specify a magnification value for the highest-resolution image.

Parameters:

magnification -

Returns:

preferredTileSize

public ImageServerMetadata.Builder preferredTileSize(int tileWidth,
 int tileHeight)

Specify the preferred tile height and width.

Parameters:

tileWidth -

tileHeight -

Returns:

channels

public ImageServerMetadata.Builder channels(Collection<ImageChannel> channels)

Specify the image channels.

Parameters:

channels -

Returns:

name

public ImageServerMetadata.Builder name(String name)

Specify the image name.

Parameters:

name -

Returns:

build

public ImageServerMetadata build()

Build an ImageServerMetadata. Note that the builder should only be used once. If a second builder is required, a new one should be initialized from an existing ImageServerMetadata object.

Returns: