Package qupath.lib.images.writers.ome

Enum Class OMEPyramidWriter.CompressionType

java.lang.Object

java.lang.Enum<OMEPyramidWriter.CompressionType>

qupath.lib.images.writers.ome.OMEPyramidWriter.CompressionType

All Implemented Interfaces:

Serializable, Comparable<OMEPyramidWriter.CompressionType>, Constable

Enclosing class:

OMEPyramidWriter

public static enum OMEPyramidWriter.CompressionType
extends Enum<OMEPyramidWriter.CompressionType>

Preferred compression type when using Bio-Formats.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Default (QuPath will select compression option based on image size and type, may be lossless or lossy).
J2K	Lossless JPEG-2000 compression.
J2K_LOSSY	Lossy JPEG-2000 compression.
JPEG	JPEG compression (only for single channel or RGB 8-bit images).
LZW	LZW compression.
UNCOMPRESSED	No compression (faster to write, no loss of information, but large file sizes).
ZLIB	ZLIB compression.

Method Summary

Modifier and Type	Method	Description
static OMEPyramidWriter.CompressionType	fromFriendlyString(String friendlyCompression)	Get the CompressionType corresponding to the given input
String	getOMEString(ImageServer<?> server)	Get the String representation understood by OMETiffWriter.
boolean	supportsImage(ImageServer<?> server)	Returns true if the compression type supports a specific image server, or false if it is incompatible.
boolean	supportsImage(PixelType pixelType, int nChannels, boolean isRGB)	Returns true if the compression type supports a specific PixelType output with the given number of channels - and (optionally) RGB status.
String	toFriendlyString()	Get a friendlier string representation
static OMEPyramidWriter.CompressionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OMEPyramidWriter.CompressionType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNCOMPRESSED

public static final OMEPyramidWriter.CompressionType UNCOMPRESSED

No compression (faster to write, no loss of information, but large file sizes).

DEFAULT

public static final OMEPyramidWriter.CompressionType DEFAULT

Default (QuPath will select compression option based on image size and type, may be lossless or lossy).

JPEG

public static final OMEPyramidWriter.CompressionType JPEG

JPEG compression (only for single channel or RGB 8-bit images).

J2K

public static final OMEPyramidWriter.CompressionType J2K

Lossless JPEG-2000 compression.

J2K_LOSSY

public static final OMEPyramidWriter.CompressionType J2K_LOSSY

Lossy JPEG-2000 compression.

LZW

public static final OMEPyramidWriter.CompressionType LZW

LZW compression.

ZLIB

public static final OMEPyramidWriter.CompressionType ZLIB

ZLIB compression.

Method Details

values

public static OMEPyramidWriter.CompressionType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OMEPyramidWriter.CompressionType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getOMEString

public String getOMEString(ImageServer<?> server)

Get the String representation understood by OMETiffWriter.

Parameters:

server - server that may be used if the type is DEFAULT

Returns:

supportsImage

public boolean supportsImage(ImageServer<?> server)

Returns true if the compression type supports a specific image server, or false if it is incompatible. This may be due to bit-depth, number of channels etc.

Parameters:

server -

Returns:

supportsImage

public boolean supportsImage(PixelType pixelType,
 int nChannels,
 boolean isRGB)

Returns true if the compression type supports a specific PixelType output with the given number of channels - and (optionally) RGB status.

Parameters:

pixelType -

nChannels -

isRGB -

Returns:

toFriendlyString

public String toFriendlyString()

Get a friendlier string representation

Returns:

fromFriendlyString

public static OMEPyramidWriter.CompressionType fromFriendlyString(String friendlyCompression)

Get the CompressionType corresponding to the given input

Parameters:

friendlyCompression -

Returns: