Package qupath.lib.images.servers
Class ZProjectedImageServer
java.lang.Object
qupath.lib.images.servers.AbstractImageServer<BufferedImage>
qupath.lib.images.servers.AbstractTileableImageServer
qupath.lib.images.servers.ZProjectedImageServer
- All Implemented Interfaces:
AutoCloseable,ImageServer<BufferedImage>
An image server that converts a z-stack into a 2D image with a projection.
Note that if the z-stack has the RGB format, transparency is not taken into account (all alpha values will be set to 255).
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumA type of projection on the Z-axis. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intConstant indicating that a full z-projection should be made using all slices, rather than a running z-projection made across a group of adjacent slices. -
Method Summary
Modifier and TypeMethodDescriptionprotected StringcreateID()Create a unique ID for the server, which can be returned as the default value ofAbstractImageServer.getPath().protected ImageServerBuilder.ServerBuilder<BufferedImage> Create a ServerBuilder, which can be used to construct an identical ImageServer.Get the original metadata read during creation of the server.A string describing the type of server, for example the name of the library used (Openslide, Bioformats...)getURIs()Get the URIs for images required for this server.protected BufferedImagereadTile(TileRequest tileRequest) Read a single image tile.Methods inherited from class qupath.lib.images.servers.AbstractTileableImageServer
allowSmoothInterpolation, createDefaultRGBImage, getDefaultColorModel, getEmptyTile, getEmptyTile, getTile, readRegionMethods 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, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface qupath.lib.images.servers.ImageServer
getPixelCalibration, readBufferedImage, readRegion, readRegion
-
Field Details
-
NO_RUNNING_OFFSET
public static final int NO_RUNNING_OFFSETConstant indicating that a full z-projection should be made using all slices, rather than a running z-projection made across a group of adjacent slices.- See Also:
-
-
Method Details
-
createServerBuilder
Description copied from class:AbstractImageServerCreate a ServerBuilder, which can be used to construct an identical ImageServer. This should also include the current metadata. It is permissible to return null for an ImageServer that cannot be recreated via aImageServerBuilder.ServerBuilder.- Specified by:
createServerBuilderin classAbstractImageServer<BufferedImage>- Returns:
-
createID
Description copied from class:AbstractImageServerCreate a unique ID for the server, which can be returned as the default value ofAbstractImageServer.getPath(). A suggested implementation isgetClass().getName() + ": " + URI + parameters
This will be called on demand wheneverAbstractImageServer.getPath()is first required.- Specified by:
createIDin classAbstractImageServer<BufferedImage>- Returns:
-
readTile
Description copied from class:AbstractTileableImageServerRead a single image tile.- Specified by:
readTilein classAbstractTileableImageServer- Parameters:
tileRequest-- Returns:
- Throws:
IOException
-
getURIs
Description copied from interface:ImageServerGet 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:
-
getServerType
Description copied from interface:ImageServerA string describing the type of server, for example the name of the library used (Openslide, Bioformats...)- Returns:
-
getOriginalMetadata
Description copied from interface:ImageServerGet the original metadata read during creation of the server. This may or may not be correct.- Returns:
- See Also:
-