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

Class DefaultPlanePyramidSource

java.lang.Object

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

net.algart.matrices.maps.pyramids.io.api.sources.DefaultPlanePyramidSource

All Implemented Interfaces:

PlanePyramidSource

public final class DefaultPlanePyramidSource
extends AbstractPlanePyramidSource
implements PlanePyramidSource

Nested Class Summary

Nested classes/interfaces inherited from class net.algart.matrices.maps.pyramids.io.api.AbstractPlanePyramidSource

AbstractPlanePyramidSource.LabelPosition, AbstractPlanePyramidSource.TileDirection, AbstractPlanePyramidSource.WholeSlideScaler

Nested classes/interfaces inherited from interface net.algart.matrices.maps.pyramids.io.api.PlanePyramidSource

PlanePyramidSource.AveragingMode, PlanePyramidSource.FlushMode, PlanePyramidSource.SpecialImageKind

Field Summary

Fields inherited from interface net.algart.matrices.maps.pyramids.io.api.PlanePyramidSource

DEFAULT_COMPRESSION, DEFAULT_MINIMAL_PYRAMID_SIZE, DEFAULT_TILE_DIM, DIM_BAND, DIM_HEIGHT, DIM_WIDTH

Constructor Summary

Constructors

Constructor	Description
DefaultPlanePyramidSource(List<? extends net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>> packedImagePyramid)

Method Summary

Modifier and Type	Method	Description
int	bandCount()
long	dim(int resolutionLevel, int index)	Returns the dimension #index of the given pyramid level.
long[]	dimensions(int resolutionLevel)	Returns dimensions of any pyramid level.
Class<?>	elementType()
void	freeResources(PlanePyramidSource.FlushMode flushMode)	This implementation frees the tile cache.
boolean	isContinuationEnabled()
boolean	isElementTypeSupported()	Returns true if PlanePyramidSource.elementType() method works properly.
boolean	isFullMatrixSupported()
boolean	isResolutionLevelAvailable(int resolutionLevel)
int	numberOfResolutions()
net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>	readFullMatrix(int resolutionLevel)
protected net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>	readLittleSubMatrix(int resolutionLevel, long fromX, long fromY, long toX, long toY)
net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>	readSubMatrix(int resolutionLevel, long fromX, long fromY, long toX, long toY)
DefaultPlanePyramidSource	setContinuationEnabled(boolean continuationEnabled)

Methods inherited from class net.algart.matrices.maps.pyramids.io.api.AbstractPlanePyramidSource

checkSubMatrixRanges, checkSubMatrixRanges, compression, constantMatrixSkippingFiller, defaultZeroLevelActualRectangles, disableTileCaching, enableTileCaching, fillBySkippingFiller, getLabelRotation, getLabelRotationBackground, getMemoryModel, getResolutionLevelsAvailability, getSkippingFiller, getTileCacheDirection, getTileCachingMemory, isDataReady, isSkipCoarseData, isSpecialMatrixSupported, isTileCachingEnabled, loadResources, makeWholeSlideFromLabelAndMap, newFilledResultMatrix, newResultMatrix, readingTileDim, readSpecialMatrix, setLabelRotation, setLabelRotationBackground, setMemoryModel, setSkipCoarseData, setSkippingFiller, setTileCachingMemory, wholeSlideDimX, zeroLevelActualAreaBoundaries

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.algart.matrices.maps.pyramids.io.api.PlanePyramidSource

compression, getResolutionLevelsAvailability, height, isDataReady, isSpecialMatrixSupported, loadResources, magnification, metadata, pixelSizeInMicrons, readSpecialMatrix, width, zeroLevelActualAreaBoundaries, zeroLevelActualRectangles

Constructor Details

DefaultPlanePyramidSource

public DefaultPlanePyramidSource(List<? extends net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>> packedImagePyramid)

Method Details

isContinuationEnabled

public boolean isContinuationEnabled()

setContinuationEnabled

public DefaultPlanePyramidSource setContinuationEnabled(boolean continuationEnabled)

numberOfResolutions

public int numberOfResolutions()

Specified by:

numberOfResolutions in interface PlanePyramidSource

Specified by:

numberOfResolutions in class AbstractPlanePyramidSource

bandCount

public int bandCount()

Specified by:

bandCount in interface PlanePyramidSource

Specified by:

bandCount in class AbstractPlanePyramidSource

isResolutionLevelAvailable

public boolean isResolutionLevelAvailable(int resolutionLevel)

Specified by:

isResolutionLevelAvailable in interface PlanePyramidSource

Overrides:

isResolutionLevelAvailable in class AbstractPlanePyramidSource

dimensions

public long[] dimensions(int resolutionLevel)
                  throws NoSuchElementException

Description copied from interface: PlanePyramidSource

Returns dimensions of any pyramid level. Number of elements in the result arrays is always 3:

• first element result[0] is always equal to PlanePyramidSource.bandCount();
• the element result[PlanePyramidSource.DIM_WIDTH] is the x-dimension of the level in pixels;
• the element result[PlanePyramidSource.DIM_HEIGHT] is the y-dimension of the level in pixels.

This method always returns a new Java array and never returns a reference to an internal field.

Specified by:

dimensions in interface PlanePyramidSource

Specified by:

dimensions in class AbstractPlanePyramidSource

Parameters:

resolutionLevel - the level of pyramid; zero level (resolutionLevel=0) corresponds to the best resolution.

Returns:

dimensions of the specified pyramid level.

Throws:

NoSuchElementException - if !isResolutionLevelAvailable(resolutionLevel)

dim

public long dim(int resolutionLevel,
 int index)

Description copied from interface: PlanePyramidSource

Returns the dimension #index of the given pyramid level. Equivalent to dimensions(resolutionLevel)[index], but works faster.

Specified by:

dim in interface PlanePyramidSource

Specified by:

dim in class AbstractPlanePyramidSource

index - the index of dimension.

Returns:

the dimension #index of this level.

isElementTypeSupported

public boolean isElementTypeSupported()

Description copied from interface: PlanePyramidSource

Returns true if PlanePyramidSource.elementType() method works properly. In other case, that method throws UnsupportedOperationException. In particular, returns true in DefaultPlanePyramidSource.

Specified by:

isElementTypeSupported in interface PlanePyramidSource

Overrides:

isElementTypeSupported in class AbstractPlanePyramidSource

Returns:

whether PlanePyramidSource.elementType() is supported.

elementType

public Class<?> elementType()

Specified by:

elementType in interface PlanePyramidSource

Overrides:

elementType in class AbstractPlanePyramidSource

isFullMatrixSupported

public boolean isFullMatrixSupported()

Specified by:

isFullMatrixSupported in interface PlanePyramidSource

readSubMatrix

public net.algart.arrays.Matrix<? extends net.algart.arrays.PArray> readSubMatrix(int resolutionLevel,
 long fromX,
 long fromY,
 long toX,
 long toY)
                                                                           throws NoSuchElementException

Specified by:

readSubMatrix in interface PlanePyramidSource

Overrides:

readSubMatrix in class AbstractPlanePyramidSource

Throws:

NoSuchElementException

readFullMatrix

public net.algart.arrays.Matrix<? extends net.algart.arrays.PArray> readFullMatrix(int resolutionLevel)
                                                                            throws NoSuchElementException

Specified by:

readFullMatrix in interface PlanePyramidSource

Overrides:

readFullMatrix in class AbstractPlanePyramidSource

Throws:

NoSuchElementException

freeResources

public void freeResources(PlanePyramidSource.FlushMode flushMode)

Description copied from class: AbstractPlanePyramidSource

This implementation frees the tile cache.

Specified by:

freeResources in interface PlanePyramidSource

Overrides:

freeResources in class AbstractPlanePyramidSource

Parameters:

flushMode - possible strategy of freeing resources (ignored by this implementation).

readLittleSubMatrix

protected net.algart.arrays.Matrix<? extends net.algart.arrays.PArray> readLittleSubMatrix(int resolutionLevel,
 long fromX,
 long fromY,
 long toX,
 long toY)

Specified by:

readLittleSubMatrix in class AbstractPlanePyramidSource