Package qupath.lib.images.servers

Class ImageServerMetadata.ImageResolutionLevel.Builder

java.lang.Object

qupath.lib.images.servers.ImageServerMetadata.ImageResolutionLevel.Builder

Enclosing class:

ImageServerMetadata.ImageResolutionLevel

public static class ImageServerMetadata.ImageResolutionLevel.Builder
extends Object

Builder to create a list of ImageServerMetadata.ImageResolutionLevel to represent pyramidal resolutions.

Constructor Summary

Constructors

Constructor	Description
Builder(int fullWidth, int fullHeight)	Constructor to help build a list of ImageServerMetadata.ImageResolutionLevel objects to represent pyramidal resolutions.

Method Summary

Modifier and Type	Method	Description
ImageServerMetadata.ImageResolutionLevel.Builder	addFullResolutionLevel()	Add the full-resolution image as a level of the pyramid.
ImageServerMetadata.ImageResolutionLevel.Builder	addLevel(double downsample, int levelWidth, int levelHeight)	Add a new level by providing a downsample value, width and height.
ImageServerMetadata.ImageResolutionLevel.Builder	addLevel(int levelWidth, int levelHeight)	Add a new level based on level dimensions, estimating the corresponding downsample value as required.
ImageServerMetadata.ImageResolutionLevel.Builder	addLevel(ImageServerMetadata.ImageResolutionLevel level)	Add a new level directly.
ImageServerMetadata.ImageResolutionLevel.Builder	addLevelByDownsample(double downsample)	Add a new level, calculating dimensions using a downsample factor applied to the full-resolution image.
List<ImageServerMetadata.ImageResolutionLevel>	build()	Build a list of ImageResolutionLevels, which can be used with an ImageServerMetadata object.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(int fullWidth,
 int fullHeight)

Constructor to help build a list of ImageServerMetadata.ImageResolutionLevel objects to represent pyramidal resolutions.

Parameters:

fullWidth - full-resolution image width

fullHeight - full-resolution image height

Method Details

addLevelByDownsample

public ImageServerMetadata.ImageResolutionLevel.Builder addLevelByDownsample(double downsample)

Add a new level, calculating dimensions using a downsample factor applied to the full-resolution image.

Parameters:

downsample -

Returns:

addFullResolutionLevel

public ImageServerMetadata.ImageResolutionLevel.Builder addFullResolutionLevel()

Add the full-resolution image as a level of the pyramid. It is not required that this form part of the pyramid in cases where this image pyramid might be used to provide a smaller overlay of a larger image, and not itself contain pixels at the highest resolution.

Returns:

addLevel

public ImageServerMetadata.ImageResolutionLevel.Builder addLevel(double downsample,
 int levelWidth,
 int levelHeight)

Add a new level by providing a downsample value, width and height. This avoids relying on any rounding decisions made when specifying the dimensions or downsample value only.

Parameters:

downsample -

levelWidth -

levelHeight -

Returns:

addLevel

public ImageServerMetadata.ImageResolutionLevel.Builder addLevel(int levelWidth,
 int levelHeight)

Add a new level based on level dimensions, estimating the corresponding downsample value as required.

Parameters:

levelWidth -

levelHeight -

Returns:

addLevel

public ImageServerMetadata.ImageResolutionLevel.Builder addLevel(ImageServerMetadata.ImageResolutionLevel level)

Add a new level directly.

Parameters:

level -

Returns:

build

public List<ImageServerMetadata.ImageResolutionLevel> build()

Build a list of ImageResolutionLevels, which can be used with an ImageServerMetadata object.

Returns: