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

Class ExtendingPlanePyramidSource

java.lang.Object

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

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

All Implemented Interfaces:

PlanePyramidSource

public final class ExtendingPlanePyramidSource
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

Method Summary

Modifier and Type	Method	Description
int	bandCount()
int	compression()
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.
long	getExtendedDimX()
long	getExtendedDimY()
Color	getExtendingBorderColor()
int	getExtendingBorderWidth()
long	getPositionXInExtendedMatrix()
long	getPositionYInExtendedMatrix()
boolean[]	getResolutionLevelsAvailability()
boolean	isDataReady()	Returns true if the data at all available levels of this source are available.
boolean	isElementTypeSupported()	Returns true if PlanePyramidSource.elementType() method works properly.
boolean	isResolutionLevelAvailable(int resolutionLevel)
boolean	isSpecialMatrixSupported(PlanePyramidSource.SpecialImageKind kind)	Returns true if this special image kind is provided by current format.
void	loadResources()	This implementation does nothing.
OptionalDouble	magnification()
Optional<String>	metadata()	Returns some additional information about this pyramid or Optional.empty() if it is not supported.
static ExtendingPlanePyramidSource	newInstance(PlanePyramidSource parent, long extendedDimX, long extendedDimY, long positionXInExtendedMatrix, long positionYInExtendedMatrix, double[] backgroundColor)
int	numberOfResolutions()
PlanePyramidSource	parent()
OptionalDouble	pixelSizeInMicrons()
protected net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>	readLittleSubMatrix(int resolutionLevel, long fromX, long fromY, long toX, long toY)
Optional<net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>>	readSpecialMatrix(PlanePyramidSource.SpecialImageKind kind)	Reads special image according specified kind.
void	setExtendingBorderColor(Color extendingBorderColor)
void	setExtendingBorderWidth(int extendingBorderWidth)
List<List<List<net.algart.math.IPoint>>>	zeroLevelActualAreaBoundaries()	Returns a set of all areas, filled by actual data, at the zero level, in a form of a list of polygons, represented by their consecutive vertices.
List<net.algart.math.IRectangularArea>	zeroLevelActualRectangles()	Returns a set of all areas, which are 2D rectangles, filled by actual data, at the zero level.

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

checkSubMatrixRanges, checkSubMatrixRanges, constantMatrixSkippingFiller, defaultZeroLevelActualRectangles, disableTileCaching, enableTileCaching, fillBySkippingFiller, getLabelRotation, getLabelRotationBackground, getMemoryModel, getSkippingFiller, getTileCacheDirection, getTileCachingMemory, isSkipCoarseData, isTileCachingEnabled, makeWholeSlideFromLabelAndMap, newFilledResultMatrix, newResultMatrix, readFullMatrix, readingTileDim, readSubMatrix, setLabelRotation, setLabelRotationBackground, setMemoryModel, setSkipCoarseData, setSkippingFiller, setTileCachingMemory, wholeSlideDimX

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

height, isFullMatrixSupported, readFullMatrix, readSubMatrix, width

Method Details

newInstance

public static ExtendingPlanePyramidSource newInstance(PlanePyramidSource parent,
 long extendedDimX,
 long extendedDimY,
 long positionXInExtendedMatrix,
 long positionYInExtendedMatrix,
 double[] backgroundColor)

parent

public PlanePyramidSource parent()

getExtendedDimX

public long getExtendedDimX()

getExtendedDimY

public long getExtendedDimY()

getPositionXInExtendedMatrix

public long getPositionXInExtendedMatrix()

getPositionYInExtendedMatrix

public long getPositionYInExtendedMatrix()

getExtendingBorderWidth

public int getExtendingBorderWidth()

setExtendingBorderWidth

public void setExtendingBorderWidth(int extendingBorderWidth)

getExtendingBorderColor

public Color getExtendingBorderColor()

setExtendingBorderColor

public void setExtendingBorderColor(Color extendingBorderColor)

numberOfResolutions

public int numberOfResolutions()

Specified by:

numberOfResolutions in interface PlanePyramidSource

Specified by:

numberOfResolutions in class AbstractPlanePyramidSource

compression

public int compression()

Specified by:

compression in interface PlanePyramidSource

Overrides:

compression 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

getResolutionLevelsAvailability

public boolean[] getResolutionLevelsAvailability()

Specified by:

getResolutionLevelsAvailability in interface PlanePyramidSource

Overrides:

getResolutionLevelsAvailability in class AbstractPlanePyramidSource

dimensions

public long[] dimensions(int resolutionLevel)

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.

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()
                     throws UnsupportedOperationException

Specified by:

elementType in interface PlanePyramidSource

Overrides:

elementType in class AbstractPlanePyramidSource

Throws:

UnsupportedOperationException

pixelSizeInMicrons

public OptionalDouble pixelSizeInMicrons()

Specified by:

pixelSizeInMicrons in interface PlanePyramidSource

magnification

public OptionalDouble magnification()

Specified by:

magnification in interface PlanePyramidSource

zeroLevelActualRectangles

public List<net.algart.math.IRectangularArea> zeroLevelActualRectangles()

Description copied from interface: PlanePyramidSource

Returns a set of all areas, which are 2D rectangles, filled by actual data, at the zero level. All other areas should be considered to be a background and may be not passed to image analysis algorithms.

Some pyramids, including the default implementation in AbstractPlanePyramidSource, do not support this feature. In this case, the method returns null. This situation may be interpreted as if we have only 1 actual area, corresponding to the whole pyramid from (0, 0) to (dimensions(0)[PlanePyramidSource.DIM_WIDTH]−1, dimensions(0)[PlanePyramidSource.DIM_HEIGHT]−1).

Specified by:

zeroLevelActualRectangles in interface PlanePyramidSource

Returns:

a list of all areas (2D rectangles), filled by actual data, at the level #0, or null if it is not supported.

zeroLevelActualAreaBoundaries

public List<List<List<net.algart.math.IPoint>>> zeroLevelActualAreaBoundaries()

Description copied from interface: PlanePyramidSource

Returns a set of all areas, filled by actual data, at the zero level, in a form of a list of polygons, represented by their consecutive vertices. All other areas should be considered to be a background and may be not passed to image analysis algorithms.

More precisely, each element P of the returned list, i.e. List<List<IPoint>>, corresponds to one connected 2D polygon. The structure of this element P is the following:

• P.get(0) is the list of sequential vertices of the polygon; each vertex appears in this list only once;
• P.get(1), P.get(2), ..., P.get(m), where m=P.size() describe sequential vertices of all polygonal holes, that may appear in the polygon. If the polygon has no holes (very probable case) or if their detection is not supported, the list P contains only 1 element (m=1).

The default implementation in AbstractPlanePyramidSource calls PlanePyramidSource.zeroLevelActualRectangles() and converts each rectangle to the list P, containing only 1 element, and this element is the list of 4 vertices of the rectangle. If PlanePyramidSource.zeroLevelActualRectangles() returns null, the default implementation also returns null.

Specified by:

zeroLevelActualAreaBoundaries in interface PlanePyramidSource

Overrides:

zeroLevelActualAreaBoundaries in class AbstractPlanePyramidSource

Returns:

the list of all polygonal areas, filled by actual data, at the level #0, and their holes (if they exist), or null if this ability is not supported.

isSpecialMatrixSupported

public boolean isSpecialMatrixSupported(PlanePyramidSource.SpecialImageKind kind)

Description copied from interface: PlanePyramidSource

Returns true if this special image kind is provided by current format.

Default implementation in AbstractPlanePyramidSource return false.

Specified by:

isSpecialMatrixSupported in interface PlanePyramidSource

Overrides:

isSpecialMatrixSupported in class AbstractPlanePyramidSource

Parameters:

kind - the kind of special image.

Returns:

whether this kind is supported; false by default.

readSpecialMatrix

public Optional<net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>> readSpecialMatrix(PlanePyramidSource.SpecialImageKind kind)
                                                                                         throws NotYetConnectedException

Description copied from interface: PlanePyramidSource

Reads special image according specified kind.

If the argument is PlanePyramidSource.SpecialImageKind.NONE, return null. In all other cases returns some non-null result.

If there is no appropriate image, returns Optional.empty()..

Specified by:

readSpecialMatrix in interface PlanePyramidSource

Overrides:

readSpecialMatrix in class AbstractPlanePyramidSource

Parameters:

kind - what special image is requested.

Returns:

special image or Optional.empty() if this kind is not supported.

Throws:

NotYetConnectedException

isDataReady

public boolean isDataReady()

Description copied from interface: PlanePyramidSource

Returns true if the data at all available levels of this source are available. In other case, PlanePyramidSource.readSubMatrix(int, long, long, long, long) and PlanePyramidSource.readFullMatrix(int) method can throw NotYetConnectedException (but also, maybe, work properly),

Note: all other methods, including PlanePyramidSource.dimensions(int), must work without NotYetConnectedException even if this method returns false.

Specified by:

isDataReady in interface PlanePyramidSource

Overrides:

isDataReady in class AbstractPlanePyramidSource

Returns:

whether the data at all available levels of this source are available.

metadata

public Optional<String> metadata()

Description copied from interface: PlanePyramidSource

Returns some additional information about this pyramid or Optional.empty() if it is not supported. The returned string should be formatted according JSON standard.

Specified by:

metadata in interface PlanePyramidSource

Returns:

additional information about the pyramid or empty result.

loadResources

public void loadResources()

Description copied from class: AbstractPlanePyramidSource

This implementation does nothing.

If your implementation overrides this method, it must call super.loadResources at the end — because it is possible that future version will do something useful.

Specified by:

loadResources in interface PlanePyramidSource

Overrides:

loadResources in class AbstractPlanePyramidSource

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)
                                                                                    throws NoSuchElementException,
NotYetConnectedException

Specified by:

readLittleSubMatrix in class AbstractPlanePyramidSource

Throws:

NoSuchElementException

NotYetConnectedException