GeneralEnvelope (Geotoolkit.org 3.x-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.geotoolkit.geometry
Class GeneralEnvelope

Object
  AbstractEnvelope
      GeneralEnvelope

All Implemented Interfaces:: Serializable, Cloneable, Envelope

public class GeneralEnvelope
extends AbstractEnvelope
implements Cloneable, Serializable
extends AbstractEnvelope
implements Cloneable, Serializable

A minimum bounding box or rectangle. Regardless of dimension, an Envelope can be represented without ambiguity as two direct positions (coordinate points). To encode an Envelope, it is sufficient to encode these two points.

Note: Envelope uses an arbitrary Coordinate Reference System, which doesn't need to be geographic. This is different than the GeographicBoundingBox class provided in the metadata package, which can be used as a kind of envelope restricted to a Geographic CRS having Greenwich prime meridian.

This particular implementation of Envelope is said "General" because it uses coordinates of an arbitrary dimension. This is in contrast with Envelope2D, which can use only two-dimensional coordinates.

A GeneralEnvelope can be created in various ways:

From a given number of dimension, with all ordinates initialized to 0.
From two coordinate points.
From a an other envelope (copy constructor).
From a geographic bounding box or a Java2D rectangle.
From a grid envelope together with a Grid to CRS transform.
From a string representing a BBOX in Well Known Text format.

Spanning the anti-meridian of a Geographic CRS
The Web Coverage Service (WCS) specification authorizes (with special treatment) cases where upper < lower at least in the longitude case. They are envelopes crossing the anti-meridian, like the red box below (the green box is the usual case). The default implementation of methods listed in the right column can handle such cases.

Supported methods:

Since:

1.2

Version:

3.20

Author:

Martin Desruisseaux (IRD, Geomatys), Simone Giannecchini (Geosolutions)

See Also:

Envelope2D, org.geotoolkit.geometry.jts.ReferencedEnvelope, DefaultGeographicBoundingBox, Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Constructor Summary
`GeneralEnvelope(CoordinateReferenceSystem crs)` Constructs an empty envelope with the specified coordinate reference system.
`GeneralEnvelope(double[] minDP, double[] maxDP)` Constructs a envelope defined by two positions.
`GeneralEnvelope(double min, double max)` Constructs one-dimensional envelope defined by a range of values.
`GeneralEnvelope(Envelope envelope)` Constructs a new envelope with the same data than the specified envelope.
`GeneralEnvelope(GeneralDirectPosition lower, GeneralDirectPosition upper)` Constructs a envelope defined by two positions.
`GeneralEnvelope(GeographicBoundingBox box)` Constructs a new envelope with the same data than the specified geographic bounding box.
`GeneralEnvelope(GridEnvelope gridEnvelope, PixelInCell anchor, MathTransform gridToCRS, CoordinateReferenceSystem crs)` Constructs a georeferenced envelope from a grid envelope transformed using the specified math transform.
`GeneralEnvelope(int dimension)` Constructs an empty envelope of the specified dimension.
`GeneralEnvelope(Rectangle2D rect)` Constructs two-dimensional envelope defined by a `Rectangle2D`.
`GeneralEnvelope(String wkt)` Constructs a new envelope initialized to the values parsed from the given string in Well Known Text (WKT) format.

Method Summary
`void`	`add(DirectPosition position)` Adds a point to this envelope.
`void`	`add(Envelope envelope)` Adds an envelope object to this envelope.
`static GeneralEnvelope`	`castOrCopy(Envelope envelope)` Returns the given envelope as a `GeneralEnvelope` instance.
`GeneralEnvelope`	`clone()` Returns a deep copy of this envelope.
`boolean`	`equals(Object object)` Compares the specified object with this envelope for equality.
`CoordinateReferenceSystem`	`getCoordinateReferenceSystem()`
`int`	`getDimension()`
`double`	`getLower(int dimension)` Returns the limit in the direction of decreasing ordinate values in the specified dimension.
`DirectPosition`	`getLowerCorner()` A coordinate position consisting of all the lower ordinates.
`double`	`getMaximum(int dimension)` Returns the maximal ordinate value for the specified dimension.
`double`	`getMedian(int dimension)` Returns the median ordinate along the specified dimension.
`double`	`getMinimum(int dimension)` Returns the minimal ordinate value for the specified dimension.
`GeneralEnvelope`	`getReducedEnvelope(int lower, int upper)` Deprecated. The implementation of this method was broken. Since this method was not used anymore (which explain why we didn't noticed its bug), it will be removed.
`double`	`getSpan(int dimension)` Returns the envelope span (typically width or height) along the specified dimension.
`GeneralEnvelope`	`getSubEnvelope(int lower, int upper)` Returns an envelope that encompass only some dimensions of this envelope.
`double`	`getUpper(int dimension)` Returns the limit in the direction of increasing ordinate values in the specified dimension.
`DirectPosition`	`getUpperCorner()` A coordinate position consisting of all the upper ordinates.
`int`	`hashCode()` Returns a hash value for this envelope.
`void`	`intersect(Envelope envelope)` Sets this envelope to the intersection if this envelope with the specified one.
`boolean`	`isEmpty()` Determines whether or not this envelope is empty.
`boolean`	`isInfinite()` Returns `true` if at least one ordinate has an infinite value.
`boolean`	`isNull()` Returns `false` if at least one ordinate value is not NaN.
`boolean`	`reduceToDomain(boolean useDomainOfCRS)` Restricts this envelope to the CS or CRS domain of validity.
`boolean`	`reorderCorners()` Tries to use a `lower` < `upper` relationship for the ordinate values in every dimension.
`void`	`roundIfAlmostInteger(double factor, int maxULP)` Fixes rounding errors up to a given tolerance level.
`void`	`setCoordinateReferenceSystem(CoordinateReferenceSystem crs)` Sets the coordinate reference system in which the coordinate are given.
`void`	`setEnvelope(double... ordinates)` Sets the envelope to the specified values, which must be the lower corner coordinates followed by upper corner coordinates.
`void`	`setEnvelope(Envelope envelope)` Sets this envelope to the same coordinate values than the specified envelope.
`void`	`setRange(int dimension, double minimum, double maximum)` Sets the envelope range along the specified dimension.
`void`	`setSubEnvelope(Envelope envelope, int offset)` Sets a sub-domain of this envelope to the same coordinate values than the specified envelope.
`void`	`setToInfinite()` Sets the lower corner to negative infinity and the upper corner to positive infinity.
`void`	`setToNull()` Sets all ordinate values to NaN.

Methods inherited from class AbstractEnvelope
`contains, contains, equals, getMedian, getSpan, intersects, toPolygonString, toRectangle2D, toString`

Methods inherited from class Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

GeneralEnvelope

public GeneralEnvelope(int dimension)

Constructs an empty envelope of the specified dimension. All ordinates are initialized to 0 and the coordinate reference system is undefined.

Parameters:: dimension - The envelope dimension.

GeneralEnvelope

public GeneralEnvelope(double min,
                       double max)

Constructs one-dimensional envelope defined by a range of values.

Parameters:: min - The lower value.; max - The upper value.

GeneralEnvelope

public GeneralEnvelope(double[] minDP,
                       double[] maxDP)

Constructs a envelope defined by two positions.

Parameters:: minDP - Lower ordinate values.; maxDP - Upper ordinate values.
Throws:: MismatchedDimensionException - if the two positions don't have the same dimension.

GeneralEnvelope

public GeneralEnvelope(GeneralDirectPosition lower,
                       GeneralDirectPosition upper)
                throws MismatchedReferenceSystemException

Constructs a envelope defined by two positions. The coordinate reference system is inferred from the supplied direct position.

Parameters:: lower - Point containing the starting ordinate values.; upper - Point containing the ending ordinate values.
Throws:: MismatchedDimensionException - if the two positions don't have the same dimension.; MismatchedReferenceSystemException - if the two positions don't use the same CRS.
See Also:: Envelope2D.Envelope2D(DirectPosition, DirectPosition)

GeneralEnvelope

public GeneralEnvelope(CoordinateReferenceSystem crs)

Constructs an empty envelope with the specified coordinate reference system. All ordinates are initialized to 0.

Parameters:: crs - The coordinate reference system.
Since:: 2.2

GeneralEnvelope

public GeneralEnvelope(Envelope envelope)

Constructs a new envelope with the same data than the specified envelope.

Parameters:: envelope - The envelope to copy.
See Also:: Envelope2D.Envelope2D(Envelope)

GeneralEnvelope

public GeneralEnvelope(GeographicBoundingBox box)

Constructs a new envelope with the same data than the specified geographic bounding box. The coordinate reference system is set to WGS84.

Parameters:: box - The bounding box to copy.
Since:: 2.4
See Also:: Envelope2D.Envelope2D(GeographicBoundingBox)

GeneralEnvelope

public GeneralEnvelope(Rectangle2D rect)

Constructs two-dimensional envelope defined by a Rectangle2D. The coordinate reference system is initially undefined.

Parameters:: rect - The rectangle to copy.
See Also:: Envelope2D.Envelope2D(CoordinateReferenceSystem, Rectangle2D)

GeneralEnvelope

public GeneralEnvelope(GridEnvelope gridEnvelope,
                       PixelInCell anchor,
                       MathTransform gridToCRS,
                       CoordinateReferenceSystem crs)
                throws IllegalArgumentException

Constructs a georeferenced envelope from a grid envelope transformed using the specified math transform. The grid to CRS transform should map either the cell center (as in OGC convention) or cell corner (as in Java2D/JAI convention) depending on the anchor value. This constructor creates an envelope containing entirely all pixels on a best effort basis - usually accurate for affine transforms.

Note: The convention is specified as a PixelInCell code instead than the more detailed PixelOrientation, because the later is restricted to the two-dimensional case while the former can be used for any number of dimensions.

Note: The envelope created by this constructor is subject to rounding errors. Consider invoking roundIfAlmostInteger(double, int) after construction for fixing them.

Parameters:: gridEnvelope - The grid envelope in integer coordinates.; anchor - Whatever grid coordinates map to pixel center or pixel corner.; gridToCRS - The transform (usually affine) from grid envelope to the CRS.; crs - The CRS for the envelope to be created, or null if unknown.
Throws:: MismatchedDimensionException - If one of the supplied object doesn't have a dimension compatible with the other objects.; IllegalArgumentException - if an argument is illegal for some other raisons, including failure to use the provided math transform.
Since:: 2.3
See Also:: GridToEnvelopeMapper, GeneralGridEnvelope.GeneralGridEnvelope(Envelope,PixelInCell,boolean)

GeneralEnvelope

public GeneralEnvelope(String wkt)
                throws NumberFormatException,
                       IllegalArgumentException

Constructs a new envelope initialized to the values parsed from the given string in Well Known Text (WKT) format. The given string is typically a BOX element like below:

BOX(-180 -90, 180 90)

However this constructor is lenient to other geometry types like POLYGON. Actually this constructor ignores the geometry type and just applies the following simple rules:

Character sequences complying to the rules of Java identifiers are skipped.
Coordinates are separated by a coma (,) character.
The ordinates in a coordinate are separated by a space.
Ordinate numbers are assumed formatted in US locale.
The coordinate having the highest dimension determines the dimension of this envelope.

This constructor does not check the consistency of the provided WKT. For example it doesn't check that every points in a LINESTRING have the same dimension. However this constructor ensures that the parenthesis are balanced, in order to catch some malformed WKT.

The following examples can be parsed by this constructor in addition of the standard BOX element. This constructor creates the bounding box of those geometries:

POINT(6 10)
MULTIPOLYGON(((1 1, 5 1, 1 5, 1 1),(2 2, 3 2, 3 3, 2 2)))
GEOMETRYCOLLECTION(POINT(4 6),LINESTRING(3 8,7 10))

Parameters:: wkt - The BOX, POLYGON or other kind of element to parse.
Throws:: NumberFormatException - If a number can not be parsed.; IllegalArgumentException - If the parenthesis are not balanced.
Since:: 3.09
See Also:: Envelopes.parseWKT(String), Envelopes.toWKT(Envelope)

Method Detail

castOrCopy

public static GeneralEnvelope castOrCopy(Envelope envelope)

Returns the given envelope as a GeneralEnvelope instance. If the given envelope is already an instance of GeneralEnvelope, then it is returned unchanged. Otherwise the coordinate values and the CRS of the given envelope are copied in a new GeneralEnvelope.

Parameters:: envelope - The envelope to cast, or null.
Returns:: The values of the given envelope as a GeneralEnvelope instance.
Since:: 3.19
See Also:: AbstractEnvelope.castOrCopy(Envelope)

getDimension

public final int getDimension()

Specified by:: getDimension in interface Envelope

getCoordinateReferenceSystem

public final CoordinateReferenceSystem getCoordinateReferenceSystem()

Specified by:: getCoordinateReferenceSystem in interface Envelope

setCoordinateReferenceSystem

public void setCoordinateReferenceSystem(CoordinateReferenceSystem crs)
                                  throws MismatchedDimensionException

Sets the coordinate reference system in which the coordinate are given. This method does not reproject the envelope, and do not check if the envelope is contained in the new domain of validity. The later can be enforced by a call to reduceToDomain(boolean).

If the envelope coordinates need to be transformed to the new CRS, consider using Envelopes.transform(Envelope, CoordinateReferenceSystem) instead.

Parameters:: crs - The new coordinate reference system, or null.
Throws:: MismatchedDimensionException - if the specified CRS doesn't have the expected number of dimensions.

reduceToDomain

public boolean reduceToDomain(boolean useDomainOfCRS)

Restricts this envelope to the CS or CRS domain of validity. This method performs two steps:

First, ensure that the envelope is contained in the coordinate system domain. If some ordinates are out of range, then there is a choice depending on the range meaning:
- If RangeMeaning.EXACT (typically latitudes ordinates), then values greater than the maximum value are replaced by the maximum, and values smaller than the minimum value are replaced by the minimum.
- If RangeMeaning.WRAPAROUND (typically longitudes ordinates), then a multiple of the range (e.g. 360° for longitudes) is added or subtracted. For example the [185 … 190]° longitude range is converted to [-175 … -170]°, and the [175 … 185]° longitude range is converted to [175 … -175]°. See Spanning the anti-meridian of a Geographic CRS in the class javadoc for more information about the meaning of such range.
If crsDomain is true, then the envelope from the previous step is intersected with the CRS domain of validity, if any.

This method is useful before to project an envelope, since some projections may produce Double.NaN numbers when given an ordinate value out of bounds. Note however that if the envelope is spanning the anti-meridian, then some lower ordinate values may become greater than upper ordinate values even if it was not the case before this method call. If this is not acceptable, consider invoking reorderCorners() after this method call.

Parameters:: useDomainOfCRS - true if the envelope should be restricted to the CRS domain of validity in addition to the CS domain.
Returns:: true if this envelope has been modified as a result of this method call, or false if no change was done.
Since:: 3.11 (derived from 2.5)

reorderCorners

public boolean reorderCorners()

Tries to use a lower < upper relationship for the ordinate values in every dimension. If a upper ordinate value is less than a lower ordinate value, then this method will shift that upper ordinate by some multiple of the axis span (typically 360° of longitude). This operation is applied only on axes having RangeMeaning.WRAPAROUND.

This method is sometime useful before to compute the union or intersection of envelopes.

Returns:: true if this envelope has been modified as a result of this method call, or false if no change was done.
Since:: 3.20

roundIfAlmostInteger

public void roundIfAlmostInteger(double factor,
                                 int maxULP)

Fixes rounding errors up to a given tolerance level. For each value ordinates[i] at dimension i, this method multiplies the ordinate value by the given factor, then round the result only if the product is close to an integer value. The threshold is defined by the maxULP argument in ULP units (Unit in the Last Place). If and only if the product has been rounded, it is divided by the factor and stored in this envelope in place of the original ordinate.

This method is useful after envelope calculations subject to rounding errors, like the GeneralEnvelope(GridEnvelope, PixelInCell, MathTransform, CoordinateReferenceSystem) constructor.

Parameters:: factor - The factor by which to multiply ordinates before rounding and divide after rounding. A recommended value is 360.; maxULP - The maximal change allowed in ULPs (Unit in the Last Place).
Since:: 3.11

setRange

public void setRange(int dimension,
                     double minimum,
                     double maximum)
              throws IndexOutOfBoundsException

Sets the envelope range along the specified dimension.

Parameters:: dimension - The dimension to set.; minimum - The minimum value along the specified dimension.; maximum - The maximum value along the specified dimension.
Throws:: IndexOutOfBoundsException - If the given index is out of bounds.

setEnvelope

public void setEnvelope(double... ordinates)

Sets the envelope to the specified values, which must be the lower corner coordinates followed by upper corner coordinates. The number of arguments provided shall be twice this envelope dimension, and minimum shall not be greater than maximum.

Example: (x_min, y_min, z_min, x_max, y_max, z_max)

Parameters:: ordinates - The new ordinate values.
Since:: 2.5

setEnvelope

public void setEnvelope(Envelope envelope)
                 throws MismatchedDimensionException

Sets this envelope to the same coordinate values than the specified envelope. If the given envelope has a non-null Coordinate Reference System (CRS), then the CRS of this envelope will be set to the CRS of the given envelope.

Parameters:: envelope - The envelope to copy coordinates from.
Throws:: MismatchedDimensionException - if the specified envelope doesn't have the expected number of dimensions.
Since:: 2.2

setSubEnvelope

public void setSubEnvelope(Envelope envelope,
                           int offset)
                    throws IndexOutOfBoundsException

Sets a sub-domain of this envelope to the same coordinate values than the specified envelope. This method copies the ordinate values of all dimensions from the given envelope to some dimensions of this envelope. The target dimensions in this envelope range from lower inclusive to lower + getDimension() exclusive.

This method ignores the Coordinate Reference System of this and the given envelope.

Parameters:: envelope - The envelope to copy coordinates from.; offset - Index of the first dimension to write in this envelope.
Throws:: IndexOutOfBoundsException - If the given offset is negative, or is greater than getDimension() - envelope.getDimension().
Since:: 3.16

getSubEnvelope

public GeneralEnvelope getSubEnvelope(int lower,
                                      int upper)
                               throws IndexOutOfBoundsException

Returns an envelope that encompass only some dimensions of this envelope. This method performs the following choice:

If the given lower and upper arguments are equal to 0 and this envelope dimension respectively, then this method returns this. Note that in such case, the CRS (if non-null) is still valid.
Otherwise, this method copies the ordinate values from this envelope into a new envelope, beginning at dimension lower and extending to dimension upper-1. The CRS of the new envelope is initialized to null. This method does not compute a new CRS because it may not be needed, or the new CRS may be already known by the caller.

Parameters:: lower - The first dimension to copy, inclusive.; upper - The last dimension to copy, exclusive.
Returns:: The sub-envelope of dimension upper-lower, which may be this.
Throws:: IndexOutOfBoundsException - if an index is out of bounds.

getReducedEnvelope

@Deprecated
public GeneralEnvelope getReducedEnvelope(int lower,
                                                     int upper)
                                   throws IndexOutOfBoundsException

Deprecated. The implementation of this method was broken. Since this method was not used anymore (which explain why we didn't noticed its bug), it will be removed.

Returns a new envelope with the same values than this envelope minus the specified range of dimensions.

Parameters:: lower - The first dimension to omit, inclusive.; upper - The last dimension to omit, exclusive.
Returns:: The sub-envelope.
Throws:: IndexOutOfBoundsException - if an index is out of bounds.

setToInfinite

public void setToInfinite()

Sets the lower corner to negative infinity and the upper corner to positive infinity. The coordinate reference system (if any) stay unchanged.

Since:: 2.2

isInfinite

public boolean isInfinite()

Returns true if at least one ordinate has an infinite value.

Returns:: true if this envelope has infinite value.
Since:: 2.2

setToNull

public void setToNull()

Sets all ordinate values to NaN. The coordinate reference system (if any) stay unchanged.

Since:: 2.2
See Also:: isNull()

add

public void add(DirectPosition position)
         throws MismatchedDimensionException,
                AssertionError

Adds a point to this envelope. The resulting envelope is the smallest envelope that contains both the original envelope and the specified point.

After adding a point, a call to contains(DirectPosition) with the added point as an argument will return true, except if one of the point ordinates was Double.NaN in which case the corresponding ordinate has been ignored.

Note: This method assumes that the specified point uses the same CRS than this envelope. For performance raisons, it will no be verified unless Java assertions are enabled.

Spanning the anti-meridian of a Geographic CRS
This method supports envelopes spanning the anti-meridian. In such cases it is possible to move both envelope borders in order to encompass the given point, as illustrated below (the new point is represented by the + symbol):

─────┐   + ┌─────
─────┘     └─────

The default implementation moves only the border which is closest to the given point.

Parameters:: position - The point to add.
Throws:: MismatchedDimensionException - if the specified point doesn't have the expected dimension.; AssertionError - If assertions are enabled and the envelopes have mismatched CRS.

add

public void add(Envelope envelope)
         throws MismatchedDimensionException,
                AssertionError

Adds an envelope object to this envelope. The resulting envelope is the union of the two Envelope objects.

Note: This method assumes that the specified envelope uses the same CRS than this envelope. For performance raisons, it will no be verified unless Java assertions are enabled.

Spanning the anti-meridian of a Geographic CRS
This method supports envelopes spanning the anti-meridian. If one or both envelopes span the anti-meridian, then the result of the add operation may be an envelope expanding to infinities. In such case, the ordinate range will be either [-∞…∞] or [0…-0] depending on whatever the original range span the anti-meridian or not.

Parameters:: envelope - the Envelope to add to this envelope.
Throws:: MismatchedDimensionException - if the specified envelope doesn't have the expected dimension.; AssertionError - If assertions are enabled and the envelopes have mismatched CRS.

intersect

public void intersect(Envelope envelope)
               throws MismatchedDimensionException,
                      AssertionError

Sets this envelope to the intersection if this envelope with the specified one.

Note: This method assumes that the specified envelope uses the same CRS than this envelope. For performance raisons, it will no be verified unless Java assertions are enabled.

Spanning the anti-meridian of a Geographic CRS
This method supports envelopes spanning the anti-meridian.

Parameters:: envelope - the Envelope to intersect to this envelope.
Throws:: MismatchedDimensionException - if the specified envelope doesn't have the expected dimension.; AssertionError - If assertions are enabled and the envelopes have mismatched CRS.

clone

public GeneralEnvelope clone()

Returns a deep copy of this envelope.

Overrides:: clone in class Object

Returns:: A clone of this envelope.
See Also:: Object.clone()

getLowerCorner

public DirectPosition getLowerCorner()

A coordinate position consisting of all the lower ordinates. The default implementation returns a unmodifiable direct position backed by this envelope, so changes in this envelope will be immediately reflected in the direct position.

Note: The Web Coverage Service (WCS) 1.1 specification uses an extended interpretation of the bounding box definition. In a WCS 1.1 data structure, the lower corner defines the edges region in the directions of decreasing coordinate values in the envelope CRS. This is usually the algebraic minimum coordinates, but not always. For example, an envelope crossing the anti-meridian could have a lower corner longitude greater than the upper corner longitude. Such extended interpretation applies mostly to axes having WRAPAROUND range meaning.

Specified by:: getLowerCorner in interface Envelope
Overrides:: getLowerCorner in class AbstractEnvelope

Returns:: The lower corner, typically (but not necessarily) containing minimal ordinate values.

getUpperCorner

public DirectPosition getUpperCorner()

A coordinate position consisting of all the upper ordinates. The default implementation returns a unmodifiable direct position backed by this envelope, so changes in this envelope will be immediately reflected in the direct position.

Note: The Web Coverage Service (WCS) 1.1 specification uses an extended interpretation of the bounding box definition. In a WCS 1.1 data structure, the upper corner defines the edges region in the directions of increasing coordinate values in the envelope CRS. This is usually the algebraic maximum coordinates, but not always. For example, an envelope crossing the anti-meridian could have an upper corner longitude less than the lower corner longitude. Such extended interpretation applies mostly to axes having WRAPAROUND range meaning.

Specified by:: getUpperCorner in interface Envelope
Overrides:: getUpperCorner in class AbstractEnvelope

Returns:: The upper corner, typically (but not necessarily) containing maximal ordinate values.

getLower

public double getLower(int dimension)
                throws IndexOutOfBoundsException

Returns the limit in the direction of decreasing ordinate values in the specified dimension. This is usually the algebraic minimum, except if this envelope spans the anti-meridian.

Specified by:: getLower in class AbstractEnvelope

Parameters:: dimension - The dimension for which to obtain the ordinate value.
Returns:: The starting ordinate value at the given dimension.
Throws:: IndexOutOfBoundsException - If the given index is negative or is equals or greater than the envelope dimension.

getUpper

public double getUpper(int dimension)
                throws IndexOutOfBoundsException

Returns the limit in the direction of increasing ordinate values in the specified dimension. This is usually the algebraic maximum, except if this envelope spans the anti-meridian.

Specified by:: getUpper in class AbstractEnvelope

Parameters:: dimension - The dimension for which to obtain the ordinate value.
Returns:: The starting ordinate value at the given dimension.
Throws:: IndexOutOfBoundsException - If the given index is negative or is equals or greater than the envelope dimension.

getMinimum

public double getMinimum(int dimension)
                  throws IndexOutOfBoundsException

Returns the minimal ordinate value for the specified dimension. In the typical case of envelopes not spanning the anti-meridian, this method returns the AbstractEnvelope.getLower(int) value verbatim. In the case of envelope spanning the anti-meridian, this method returns the axis minimum value.

Specified by:: getMinimum in interface Envelope
Overrides:: getMinimum in class AbstractEnvelope

Parameters:: dimension - The dimension for which to obtain the ordinate value.
Returns:: The minimal ordinate value at the given dimension.
Throws:: IndexOutOfBoundsException - If the given index is negative or is equals or greater than the envelope dimension.

getMaximum

public double getMaximum(int dimension)
                  throws IndexOutOfBoundsException

Returns the maximal ordinate value for the specified dimension. In the typical case of envelopes not spanning the anti-meridian, this method returns the AbstractEnvelope.getUpper(int) value verbatim. In the case of envelope spanning the anti-meridian, this method returns the axis maximum value.

Specified by:: getMaximum in interface Envelope
Overrides:: getMaximum in class AbstractEnvelope

Parameters:: dimension - The dimension for which to obtain the ordinate value.
Returns:: The maximal ordinate value at the given dimension.
Throws:: IndexOutOfBoundsException - If the given index is negative or is equals or greater than the envelope dimension.

getMedian

public double getMedian(int dimension)
                 throws IndexOutOfBoundsException

Returns the median ordinate along the specified dimension. In most cases, the result is equals (minus rounding error) to:

median = (getUpper(dimension) + getLower(dimension)) / 2;

Spanning the anti-meridian of a Geographic CRS
If upper < lower and the range meaning for the requested dimension is wraparound, then the median calculated above is actually in the middle of the space outside the envelope. In such cases, this method shifts the median value by half of the periodicity (180° in the longitude case) in order to switch from outer space to inner space. If the axis range meaning is not WRAPAROUND, then this method returns NaN.

Specified by:: getMedian in interface Envelope
Overrides:: getMedian in class AbstractEnvelope

Parameters:: dimension - The dimension for which to obtain the ordinate value.
Returns:: The median ordinate at the given dimension, or Double.NaN.
Throws:: IndexOutOfBoundsException - If the given index is negative or is equals or greater than the envelope dimension.

getSpan

public double getSpan(int dimension)
               throws IndexOutOfBoundsException

Returns the envelope span (typically width or height) along the specified dimension. In most cases, the result is equals (minus rounding error) to:

span = getUpper(dimension) - getLower(dimension);

Spanning the anti-meridian of a Geographic CRS
If upper < lower and the range meaning for the requested dimension is wraparound, then the span calculated above is negative. In such cases, this method adds the periodicity (typically 360° of longitude) to the span. If the result is a positive number, it is returned. Otherwise this method returns NaN.

Specified by:: getSpan in interface Envelope
Overrides:: getSpan in class AbstractEnvelope

Parameters:: dimension - The dimension for which to obtain the span.
Returns:: The span (typically width or height) at the given dimension, or Double.NaN.
Throws:: IndexOutOfBoundsException - If the given index is negative or is equals or greater than the envelope dimension.

isEmpty

public boolean isEmpty()

Determines whether or not this envelope is empty. An envelope is non-empty only if it has at least one dimension, and the span is greater than 0 along all dimensions. Note that a non-empty envelope is always non-null, but the converse is not always true.

Overrides:: isEmpty in class AbstractEnvelope

Returns:: true if this envelope is empty.
See Also:: DefaultGeographicBoundingBox.isEmpty(), RectangularShape.isEmpty()

isNull

public boolean isNull()

Returns false if at least one ordinate value is not NaN. The isNull() check is a little bit different than AbstractEnvelope.isEmpty() since it returns false for a partially initialized envelope, while isEmpty() returns false only after all dimensions have been initialized. More specifically, the following rules apply:

If isNull() == true, then AbstractEnvelope.isEmpty() == true
If AbstractEnvelope.isEmpty() == false, then isNull() == false
The converse of the above-cited rules are not always true.

Overrides:: isNull in class AbstractEnvelope

Returns:: true if this envelope has NaN values.
See Also:: setToNull()

hashCode

public int hashCode()

Returns a hash value for this envelope.

Overrides:: hashCode in class AbstractEnvelope

equals

public boolean equals(Object object)

Compares the specified object with this envelope for equality.

Overrides:: equals in class AbstractEnvelope

Parameters:: object - The object to compare with this envelope.
Returns:: true if the given object is equal to this envelope.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.geotoolkit.geometry Class GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

GeneralEnvelope

castOrCopy

getDimension

getCoordinateReferenceSystem

setCoordinateReferenceSystem

reduceToDomain

reorderCorners

roundIfAlmostInteger

setRange

setEnvelope

setEnvelope

setSubEnvelope

getSubEnvelope

getReducedEnvelope

setToInfinite

isInfinite

setToNull

add

add

intersect

clone

getLowerCorner

getUpperCorner

getLower

getUpper

getMinimum

getMaximum

getMedian

getSpan

isEmpty

isNull

hashCode

equals

org.geotoolkit.geometry
Class GeneralEnvelope