Package qupath.lib.experimental.pixels

Class Parameters<S,T>

java.lang.Object

qupath.lib.experimental.pixels.Parameters<S,T>

Type Parameters:

S - the image type

T - the mask type

public class Parameters<S,T>
extends Object

Parameters for use with a PixelProcessor.

Since:

v0.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameters.Builder<S,T>	Builder class for Parameters.

Method Summary

Modifier and Type	Method	Description
static <S, T> Parameters.Builder<S,T>	builder()	Create a new builder for parameters.
S	getImage()	Get the image to process.
ImageData<BufferedImage>	getImageData()	Get the image data.
T	getMask()	Get the mask associated with the main ROI or the parent object, or null if no mask is available.
T	getMask(ROI roi)	Get the mask associated with any ROI, or null if no mask is available.
PathObject	getParent()	Get the parent object.
PathObject	getParentOrProxy()	Get the parent, or a proxy parent if one has been specified.
RegionRequest	getRegionRequest()	Get the region request.
ImageServer<BufferedImage>	getServer()	Get the server.
TileRequest	getTileRequest()	Get the tile request, if available.

Methods inherited from class java.lang.Object

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

Method Details

getImageData

public ImageData<BufferedImage> getImageData()

Get the image data.

Returns:

getServer

public ImageServer<BufferedImage> getServer()

Get the server. This is often the accessed from getImageData(), but in some cases it may be different (e.g. if the processing should be applied to a transformed image).

Returns:

getRegionRequest

public RegionRequest getRegionRequest()

Get the region request.

Returns:

getTileRequest

public TileRequest getTileRequest()

Get the tile request, if available. This should be used when the region request is derived at a specific tile resolution, because it is able to provide more accurate tile coordinates without rounding errors.

Returns:

getImage

public S getImage()
           throws IOException

Get the image to process. This may return a cached value, so it is important that it is not modified by the caller.

Returns:

Throws:

IOException

getMask

public T getMask()
          throws IOException

Get the mask associated with the main ROI or the parent object, or null if no mask is available. Note that the mask returned should correspond to the same region as getImage() - and not the bounds of the ROI.

Returns:

Throws:

IOException

getMask

public T getMask(ROI roi)
          throws IOException

Get the mask associated with any ROI, or null if no mask is available. Note that the mask returned should correspond to the same region as getImage() - and not the bounds of the ROI.

Parameters:

roi -

Returns:

Throws:

IOException

getParent

public PathObject getParent()

Get the parent object.

Returns:

See Also:

• getParentOrProxy()

getParentOrProxy

public PathObject getParentOrProxy()

Get the parent, or a proxy parent if one has been specified. The proxy parent is used to provide a temporary parent object for tiled processing, when using the parent directly may be problematic (e.g. because the region is too large).

Returns:

See Also:

• getParent()

builder

public static <S,
T> Parameters.Builder<S,T> builder()

Create a new builder for parameters.

Type Parameters:

S -

T -

Returns: