Package qupath.lib.images.servers.openslide.jna

Class OpenSlide

java.lang.Object

qupath.lib.images.servers.openslide.jna.OpenSlide

All Implemented Interfaces:

Closeable, AutoCloseable

public final class OpenSlide
extends Object
implements Closeable

Minimal Java wrapper for OpenSlide.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenSlide.OpenSlideDisposedException	Exception thrown whenever a request is made after the OpenSlide object has been closed.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_NAME_BACKGROUND_COLOR
static final String	PROPERTY_NAME_BOUNDS_HEIGHT
static final String	PROPERTY_NAME_BOUNDS_WIDTH
static final String	PROPERTY_NAME_BOUNDS_X
static final String	PROPERTY_NAME_BOUNDS_Y
static final String	PROPERTY_NAME_COMMENT
static final String	PROPERTY_NAME_MPP_X
static final String	PROPERTY_NAME_MPP_Y
static final String	PROPERTY_NAME_OBJECTIVE_POWER
static final String	PROPERTY_NAME_QUICKHASH1
static final String	PROPERTY_NAME_VENDOR

Method Summary

Modifier and Type	Method	Description
void	close()	Close; this is important for cleanup.
void	dispose()	Dispose the OpenSlide object; this is equivalent to close().
BufferedImage	getAssociatedImage(String name)	Get a named associated image.
List<String>	getAssociatedImages()	Get a list of all associated image names.
byte[]	getICCProfileBytes()	Request the bytes for an ICC profile.
long	getLevel0Height()	Get the height of the full-resolution image (level 0).
long	getLevel0Width()	Get the width of the full-resolution image (level 0).
int	getLevelCount()	Get the total number of pyramid levels.
long	getLevelHeight(int level)	Get the image height at the specified level.
long	getLevelWidth(int level)	Get the image width at the specified level.
Map<String,String>	getProperties()	Get an unmodifiable map of all available properties.
void	paintRegionARGB(int[] dest, long x, long y, int level, int w, int h)

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_NAME_COMMENT

public static final String PROPERTY_NAME_COMMENT

See Also:

• Constant Field Values

PROPERTY_NAME_VENDOR

public static final String PROPERTY_NAME_VENDOR

See Also:

• Constant Field Values

PROPERTY_NAME_QUICKHASH1

public static final String PROPERTY_NAME_QUICKHASH1

See Also:

• Constant Field Values

PROPERTY_NAME_BACKGROUND_COLOR

public static final String PROPERTY_NAME_BACKGROUND_COLOR

See Also:

• Constant Field Values

PROPERTY_NAME_OBJECTIVE_POWER

public static final String PROPERTY_NAME_OBJECTIVE_POWER

See Also:

• Constant Field Values

PROPERTY_NAME_MPP_X

public static final String PROPERTY_NAME_MPP_X

See Also:

• Constant Field Values

PROPERTY_NAME_MPP_Y

public static final String PROPERTY_NAME_MPP_Y

See Also:

• Constant Field Values

PROPERTY_NAME_BOUNDS_X

public static final String PROPERTY_NAME_BOUNDS_X

See Also:

• Constant Field Values

PROPERTY_NAME_BOUNDS_Y

public static final String PROPERTY_NAME_BOUNDS_Y

See Also:

• Constant Field Values

PROPERTY_NAME_BOUNDS_WIDTH

public static final String PROPERTY_NAME_BOUNDS_WIDTH

See Also:

• Constant Field Values

PROPERTY_NAME_BOUNDS_HEIGHT

public static final String PROPERTY_NAME_BOUNDS_HEIGHT

See Also:

• Constant Field Values

Method Details

dispose

public void dispose()

Dispose the OpenSlide object; this is equivalent to close().

getLevelCount

public int getLevelCount()

Get the total number of pyramid levels.

Returns:

getLevel0Width

public long getLevel0Width()

Get the width of the full-resolution image (level 0).

Returns:

getLevel0Height

public long getLevel0Height()

Get the height of the full-resolution image (level 0).

Returns:

getLevelWidth

public long getLevelWidth(int level)

Get the image width at the specified level.

Parameters:

level -

Returns:

getLevelHeight

public long getLevelHeight(int level)

Get the image height at the specified level.

Parameters:

level -

Returns:

paintRegionARGB

public void paintRegionARGB(int[] dest,
 long x,
 long y,
 int level,
 int w,
 int h)
                     throws IOException

Throws:

IOException

getProperties

public Map<String,String> getProperties()

Get an unmodifiable map of all available properties.

Returns:

getAssociatedImage

public BufferedImage getAssociatedImage(String name)
                                 throws IOException

Get a named associated image.

Parameters:

name -

Returns:

Throws:

IOException

getAssociatedImages

public List<String> getAssociatedImages()

Get a list of all associated image names.

Returns:

close

public void close()

Close; this is important for cleanup.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getICCProfileBytes

public byte[] getICCProfileBytes()
                          throws UnsupportedOperationException

Request the bytes for an ICC profile.

Returns:

the bytes of an ICC profile is available, or null otherwise.

Throws:

UnsupportedOperationException - if an unsatisfied link error occurred, which indicates that the OpenSlide version is not compatible (it should be 4.0.0 or greater).