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

Class AbstractPlanePyramidSourceWrapper

java.lang.Object

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

All Implemented Interfaces:

PlanePyramidSource

Direct Known Subclasses:

ImageIOPlanePyramidSource

public abstract class AbstractPlanePyramidSourceWrapper
extends Object
implements PlanePyramidSource

Nested Class Summary

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
AbstractPlanePyramidSourceWrapper()

Method Summary

Modifier and Type	Method	Description
int	bandCount()
int	compression()
long[]	dimensions(int resolutionLevel)	Returns dimensions of any pyramid level.
Class<?>	elementType()
void	freeResources(PlanePyramidSource.FlushMode flushMode)
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	isFullMatrixSupported()
boolean	isResolutionLevelAvailable(int resolutionLevel)
boolean	isSpecialMatrixSupported(PlanePyramidSource.SpecialImageKind kind)	Returns true if this special image kind is provided by current format.
void	loadResources()	Re-initializes object and loads all necessary resources.
OptionalDouble	magnification()
Optional<String>	metadata()	Returns some additional information about this pyramid or Optional.empty() if it is not supported.
int	numberOfResolutions()
protected abstract PlanePyramidSource	parent()
OptionalDouble	pixelSizeInMicrons()
net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>	readFullMatrix(int resolutionLevel)
Optional<net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>>	readSpecialMatrix(PlanePyramidSource.SpecialImageKind kind)	Reads special image according specified kind.
net.algart.arrays.Matrix<? extends net.algart.arrays.PArray>	readSubMatrix(int resolutionLevel, long fromX, long fromY, long toX, long toY)
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 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

dim, height, width

Constructor Details

AbstractPlanePyramidSourceWrapper

public AbstractPlanePyramidSourceWrapper()

Method Details

parent

protected abstract PlanePyramidSource parent()

numberOfResolutions

public int numberOfResolutions()

Specified by:

numberOfResolutions in interface PlanePyramidSource

compression

public int compression()

Specified by:

compression in interface PlanePyramidSource

bandCount

public int bandCount()

Specified by:

bandCount in interface PlanePyramidSource

isResolutionLevelAvailable

public boolean isResolutionLevelAvailable(int resolutionLevel)

Specified by:

isResolutionLevelAvailable in interface PlanePyramidSource

getResolutionLevelsAvailability

public boolean[] getResolutionLevelsAvailability()

Specified by:

getResolutionLevelsAvailability in interface PlanePyramidSource

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

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)

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

Returns:

whether PlanePyramidSource.elementType() is supported.

elementType

public Class<?> elementType()
                     throws UnsupportedOperationException

Specified by:

elementType in interface PlanePyramidSource

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

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.

readSubMatrix

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

Specified by:

readSubMatrix in interface PlanePyramidSource

Throws:

NoSuchElementException

NotYetConnectedException

isFullMatrixSupported

public boolean isFullMatrixSupported()

Specified by:

isFullMatrixSupported in interface PlanePyramidSource

readFullMatrix

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

Specified by:

readFullMatrix in interface PlanePyramidSource

Throws:

NoSuchElementException

NotYetConnectedException

UnsupportedOperationException

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

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

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

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 interface: PlanePyramidSource

Re-initializes object and loads all necessary resources.

This method should be called before using this object, if PlanePyramidSource.freeResources(FlushMode) was called before. If you will not directly call this method, all will work normally, but some classes may work more slowly. For example, some classes may work with clones of this object, so, if it is not initialized, then all its clones will be also non-initialized and will be reinitialized while every usage.

Specified by:

loadResources in interface PlanePyramidSource

freeResources

public void freeResources(PlanePyramidSource.FlushMode flushMode)

Specified by:

freeResources in interface PlanePyramidSource