Package net.algart.matrices.maps.pyramids.io.api

Enum Class PlanePyramidSource.SpecialImageKind

java.lang.Object

java.lang.Enum<PlanePyramidSource.SpecialImageKind>

net.algart.matrices.maps.pyramids.io.api.PlanePyramidSource.SpecialImageKind

All Implemented Interfaces:

Serializable, Comparable<PlanePyramidSource.SpecialImageKind>, Constable

Enclosing interface:

PlanePyramidSource

public static enum PlanePyramidSource.SpecialImageKind
extends Enum<PlanePyramidSource.SpecialImageKind>

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
CUSTOM_KIND_1	Some format-specific special image.
CUSTOM_KIND_2	Some format-specific special image.
CUSTOM_KIND_3	Some format-specific special image.
CUSTOM_KIND_4	Some format-specific special image.
CUSTOM_KIND_5	Some format-specific special image.
INVALID	Impossible image kind, that should be never returned for correct special images, but can be returned by some methods to indicate special situation (for example, when it is not a special image).
LABEL_ONLY_IMAGE	The label image: a little photo of some paper on the scan with printed or written information about the slide.
MAP_IMAGE	Coarse image with all existing pyramid data.
NONE	No image.
SMALLEST_LAYER	Simplest universal thumbnail: the last (smallest) available level of the full image.
THUMBNAIL_IMAGE	The thumbnail: something like MAP_IMAGE, but containing the same information as a regular pyramid (while MAP_IMAGE may contain other coarse data).
WHOLE_SLIDE	Coarse image of the full slide.

Method Summary

Modifier and Type	Method	Description
static PlanePyramidSource.SpecialImageKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlanePyramidSource.SpecialImageKind[]	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

NONE

public static final PlanePyramidSource.SpecialImageKind NONE

No image.

When passed to PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method, the result is always empty (Optional.empty()).

WHOLE_SLIDE

public static final PlanePyramidSource.SpecialImageKind WHOLE_SLIDE

Coarse image of the full slide. Usually contains the label as a part.

Some implementations of PlanePyramidSource can use it automatically as the background for the pyramid data.

MAP_IMAGE

public static final PlanePyramidSource.SpecialImageKind MAP_IMAGE

Coarse image with all existing pyramid data. Never contains the label. May be used, for example, for visual navigation goals.

LABEL_ONLY_IMAGE

public static final PlanePyramidSource.SpecialImageKind LABEL_ONLY_IMAGE

The label image: a little photo of some paper on the scan with printed or written information about the slide.

THUMBNAIL_IMAGE

public static final PlanePyramidSource.SpecialImageKind THUMBNAIL_IMAGE

The thumbnail: something like MAP_IMAGE, but containing the same information as a regular pyramid (while MAP_IMAGE may contain other coarse data). Usually generated automatically by scanner software and looks like last available levels.

SMALLEST_LAYER

public static final PlanePyramidSource.SpecialImageKind SMALLEST_LAYER

Simplest universal thumbnail: the last (smallest) available level of the full image. When passed to PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method, the result is always the full image, returned by readFullMatrix(numberOfResolutions()-1).

You may use this variant instead of any other special kind, if PlanePyramidSource.isSpecialMatrixSupported(SpecialImageKind) informs that a kind is not supported (though it is not a good idea for replacement of LABEL_ONLY_IMAGE). But you need to remember that some pyramids has only large layers, so this "thumbnail" can be very large.

For this kind, result of PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method is never empty.

CUSTOM_KIND_1

public static final PlanePyramidSource.SpecialImageKind CUSTOM_KIND_1

Some format-specific special image.

If the format does not provide such an image, PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method returns the empty result for this kind (Optional.empty()).

CUSTOM_KIND_2

public static final PlanePyramidSource.SpecialImageKind CUSTOM_KIND_2

Some format-specific special image.

If the format does not provide such an image, PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method returns the empty result for this kind (Optional.empty()).

CUSTOM_KIND_3

public static final PlanePyramidSource.SpecialImageKind CUSTOM_KIND_3

Some format-specific special image.

If the format does not provide such an image, PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method returns the empty result for this kind (Optional.empty()).

CUSTOM_KIND_4

public static final PlanePyramidSource.SpecialImageKind CUSTOM_KIND_4

Some format-specific special image.

If the format does not provide such an image, PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method returns the empty result for this kind (Optional.empty()).

CUSTOM_KIND_5

public static final PlanePyramidSource.SpecialImageKind CUSTOM_KIND_5

Some format-specific special image.

If the format does not provide such an image, PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method returns the empty result for this kind (Optional.empty()).

INVALID

public static final PlanePyramidSource.SpecialImageKind INVALID

Impossible image kind, that should be never returned for correct special images, but can be returned by some methods to indicate special situation (for example, when it is not a special image).

When passed to PlanePyramidSource.readSpecialMatrix(SpecialImageKind) method, the result is always empty (Optional.empty()), as for NONE kind.

Method Details

values

public static PlanePyramidSource.SpecialImageKind[] 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 PlanePyramidSource.SpecialImageKind 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