org.geolatte.geom.curve

Class MortonContext<P extends C2D>

java.lang.Object

org.geolatte.geom.curve.MortonContext<P>

public class MortonContext<P extends C2D>
extends java.lang.Object

A context for the calculation of Morton codes.

This class holds the the maximum spatial extent and tree-depth of the implied QuadTree-index for a MortonCode.

Field Summary

Fields

Modifier and Type	Field and Description
private int	depth
private static java.lang.String	ERR_MSG_MAX_DEPTH
private static java.lang.String	ERR_MSG_NULL
private Envelope<P>	extent
private double	leafHeight
private double	leafWidth
private int	numOfDivisionsAlongAxis

Constructor Summary

Constructors

Constructor and Description
MortonContext(Envelope<P> extent, int depth) Constructs a MortonContext with the specified extent and max.

Method Summary

Modifier and Type	Method and Description
boolean	extentContains(Envelope<P> envelope) Checks whether the specified Envelope is contained in the extent.
boolean	extentContains(P pos) Checks whether the specified Point is contained in the extent.
CoordinateReferenceSystem<?>	getCoordinateReferenceSystem() Returns the CrsId of the spatial extent
int	getDepth() Returns the maximum tree-depth
Envelope<P>	getExtent() Returns the spatial extent of this instance
(package private) double	getLeafHeight() Returns the height of the extent of a leaf in the QuadTree at tree-depth (lowest-level)
(package private) double	getLeafWidth() Returns the width of the extent of a leaf in the QuadTree at tree-depth (lowest-level)
double	getMaxX() Returns the maximum X-coordinate of the extent.
double	getMaxY() Returns the maximum Y-coordinate of the extent.
double	getMinX() Returns the minimum X-coordinate of the extent
double	getMinY() Returns the minimum Y-coordinate of the extent
(package private) int	getNumberOfDivisionsAlongAxis() Returns the number of subdivisions along an (X- or Y-)axis.

Methods inherited from class java.lang.Object

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

Field Detail

ERR_MSG_MAX_DEPTH

private static final java.lang.String ERR_MSG_MAX_DEPTH

See Also:

Constant Field Values

ERR_MSG_NULL

private static final java.lang.String ERR_MSG_NULL

See Also:

Constant Field Values

depth

private final int depth

extent

private final Envelope<P extends C2D> extent

numOfDivisionsAlongAxis

private final int numOfDivisionsAlongAxis

leafWidth

private final double leafWidth

leafHeight

private final double leafHeight

Constructor Detail

MortonContext

public MortonContext(Envelope<P> extent,
                     int depth)

Constructs a MortonContext with the specified extent and max. tree-depth

Parameters:

extent - the extent for this instance

depth - the tree-depth

Method Detail

getMaxX

public double getMaxX()

Returns the maximum X-coordinate of the extent.

Returns:

the maximum X-coordinate of the extent

getMaxY

public double getMaxY()

Returns the maximum Y-coordinate of the extent.

Returns:

the maximum Y-coordinate of the extent

getMinX

public double getMinX()

Returns the minimum X-coordinate of the extent

Returns:

the minimum X-coordinate of the extent

getMinY

public double getMinY()

Returns the minimum Y-coordinate of the extent

Returns:

the minimum Y-coordinate of the extent

getDepth

public int getDepth()

Returns the maximum tree-depth

Returns:

the maximum tree-depth

getCoordinateReferenceSystem

public CoordinateReferenceSystem<?> getCoordinateReferenceSystem()

Returns the CrsId of the spatial extent

Returns:

the CrsId of the spatial extent

getNumberOfDivisionsAlongAxis

int getNumberOfDivisionsAlongAxis()

Returns the number of subdivisions along an (X- or Y-)axis.

The leaves of a Quadtree form a grid-cell structure that completely covers the extent. This method returns the number of subdivisions along a single axis. It is the square root of the total number of leaves.

Returns:

the number of subdivisions along an (X- or Y-)axis.

getLeafWidth

double getLeafWidth()

Returns the width of the extent of a leaf in the QuadTree at tree-depth (lowest-level)

Returns:

the width of the extent of a leaf in the QuadTree at tree-depth (lowest-level)

getLeafHeight

double getLeafHeight()

Returns the height of the extent of a leaf in the QuadTree at tree-depth (lowest-level)

Returns:

the height of the extent of a leaf in the QuadTree at tree-depth (lowest-level)

extentContains

public boolean extentContains(P pos)

Checks whether the specified Point is contained in the extent.

Parameters:

pos - a Point value

Returns:

true if the specified point is contained in the extent, false otherwise

Throws:

java.lang.IllegalArgumentException - if the specified point does not share this extent's CrsId

extentContains

public boolean extentContains(Envelope<P> envelope)

Checks whether the specified Envelope is contained in the extent.

Parameters:

envelope - an Envelope value

Returns:

true if the specified envelope is contained in the extent, false otherwise

Throws:

java.lang.IllegalArgumentException - if the specified envelope does not share this extent's CrsId

getExtent

public Envelope<P> getExtent()

Returns the spatial extent of this instance

Returns:

an Envelope representing the spatial extent of this instance