Enum Class PlanePyramidSource.SpecialImageKind
- All Implemented Interfaces:
Serializable,Comparable<PlanePyramidSource.SpecialImageKind>,Constable
- Enclosing interface:
- PlanePyramidSource
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionSome format-specific special image.Some format-specific special image.Some format-specific special image.Some format-specific special image.Some format-specific special image.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).The label image: a little photo of some paper on the scan with printed or written information about the slide.Coarse image with all existing pyramid data.No image.Simplest universal thumbnail: the last (smallest) available level of the full image.Coarse image of the full slide. -
Method Summary
Modifier and TypeMethodDescriptionReturns 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.
-
Enum Constant Details
-
NONE
No image.When passed to
PlanePyramidSource.readSpecialMatrix(SpecialImageKind)method, the result is always empty (Optional.empty()). -
WHOLE_SLIDE
Coarse image of the full slide. Usually contains thelabelas a part.Some implementations of
PlanePyramidSourcecan use it automatically as the background for the pyramid data. -
MAP_IMAGE
Coarse image with all existing pyramid data. Never contains thelabel. May be used, for example, for visual navigation goals. -
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
-
SMALLEST_LAYER
Simplest universal thumbnail: the last (smallest) available level of the full image. When passed toPlanePyramidSource.readSpecialMatrix(SpecialImageKind)method, the result is always the full image, returned byreadFullMatrix(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 ofLABEL_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
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
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
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
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
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
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 forNONEkind.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-