org.geotools.geometry
Class GeneralEnvelope

Object
  extended by AbstractEnvelope
      extended by GeneralEnvelope
All Implemented Interfaces:
Serializable, Cloneable, Envelope

public class GeneralEnvelope
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.

This particular implementation of Envelope is said "General" because it uses coordinates of an arbitrary dimension.

Tip: The metadata package provides a GeographicBoundingBox, which can be used as a kind of envelope with a coordinate reference system fixed to WGS 84 (EPSG:4326).

Since:
2.0
Author:
Martin Desruisseaux (IRD), Simone Giannecchini
See Also:
Envelope2D, ReferencedEnvelope, GeographicBoundingBox, Serialized Form

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 minDP, GeneralDirectPosition maxDP)
          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 gridRange, PixelInCell anchor, MathTransform gridToCRS, CoordinateReferenceSystem crs)
          Creates an envelope for a grid range transformed to an envelope 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.
 
Method Summary
 void add(DirectPosition position)
          Adds a point to this envelope.
 void add(Envelope envelope)
          Adds an envelope object to this envelope.
 GeneralEnvelope clone()
          Returns a deep copy of this envelope.
 boolean contains(DirectPosition position)
          Tests if a specified coordinate is inside the boundary of this envelope.
 boolean contains(Envelope envelope, boolean edgesInclusive)
          Returns true if this envelope completly encloses the specified envelope.
 boolean equals(Envelope envelope, double eps, boolean epsIsRelative)
          Compares to the specified envelope for equality up to the specified tolerance value.
 boolean equals(Object object)
          Compares the specified object with this envelope for equality.
 CoordinateReferenceSystem getCoordinateReferenceSystem()
          Returns the coordinate reference system in which the coordinates are given.
 int getDimension()
          Returns the number of dimensions.
 DirectPosition getLowerCorner()
          A coordinate position consisting of all the minimal ordinates for each dimension for all points within the Envelope.
 double getMaximum(int dimension)
          Returns the maximal ordinate along the specified dimension.
 DirectPosition getMedian()
          A coordinate position consisting of all the middle ordinates for each dimension for all points within the Envelope.
 double getMedian(int dimension)
          Returns the median ordinate along the specified dimension.
 double getMinimum(int dimension)
          Returns the minimal ordinate along the specified dimension.
 GeneralEnvelope getReducedEnvelope(int lower, int upper)
          Returns a new envelope with the same values than this envelope minus the specified range of dimensions.
 double getSpan(int dimension)
          Returns the envelope span (typically width or height) along the specified dimension.
 double getSpan(int dimension, Unit<?> unit)
          Returns the envelope span along the specified dimension, in terms of the given units.
 GeneralEnvelope getSubEnvelope(int lower, int upper)
          Returns a new envelope that encompass only some dimensions of this envelope.
 DirectPosition getUpperCorner()
          A coordinate position consisting of all the maximal ordinates for each dimension for all points within the Envelope.
 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 intersects(Envelope envelope, boolean edgesInclusive)
          Returns true if this envelope intersects the specified envelope.
 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 normalize(boolean crsDomain)
          Restricts this envelope to the CS or CRS domain of validity.
 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(GeneralEnvelope envelope)
          Sets this envelope to the same coordinate values than the specified envelope.
 void setRange(int dimension, double minimum, double maximum)
          Sets the envelope's range along the specified dimension.
 void setToInfinite()
          Sets the lower corner to negative infinity and the upper corner to positive infinity.
 void setToNull()
          Sets all ordinate values to NaN.
 Rectangle2D toRectangle2D()
          Returns a Rectangle2D with the same bounds as this Envelope.
 
Methods inherited from class AbstractEnvelope
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 minimal value.
max - The maximal value.

GeneralEnvelope

public GeneralEnvelope(double[] minDP,
                       double[] maxDP)
                throws IllegalArgumentException
Constructs a envelope defined by two positions.

Parameters:
minDP - Minimum ordinate values.
maxDP - Maximum ordinate values.
Throws:
MismatchedDimensionException - if the two positions don't have the same dimension.
IllegalArgumentException - if an ordinate value in the minimum point is not less than or equal to the corresponding ordinate value in the maximum point.

GeneralEnvelope

public GeneralEnvelope(GeneralDirectPosition minDP,
                       GeneralDirectPosition maxDP)
                throws MismatchedReferenceSystemException,
                       IllegalArgumentException
Constructs a envelope defined by two positions. The coordinate reference system is inferred from the supplied direct position.

Parameters:
minDP - Point containing minimum ordinate values.
maxDP - Point containing maximum 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.
IllegalArgumentException - if an ordinate value in the minimum point is not less than or equal to the corresponding ordinate value in the maximum point.

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.

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

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.

GeneralEnvelope

public GeneralEnvelope(GridEnvelope gridRange,
                       PixelInCell anchor,
                       MathTransform gridToCRS,
                       CoordinateReferenceSystem crs)
                throws IllegalArgumentException
Creates an envelope for a grid range transformed to an envelope 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 detailled PixelOrientation, because the later is restricted to the two-dimensional case while the former can be used for any number of dimensions.

Parameters:
gridRange - The grid range.
anchor - Whatever grid range coordinates map to pixel center or pixel corner.
gridToCRS - The transform (usually affine) from grid range to the envelope CRS.
crs - The envelope CRS, or null if unknow.
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 reason, including failure to use the provided math transform.
Since:
2.3
See Also:
GeneralGridEnvelope.GeneralGridEnvelope(Envelope,PixelInCell,boolean)
Method Detail

getCoordinateReferenceSystem

public final CoordinateReferenceSystem getCoordinateReferenceSystem()
Returns the coordinate reference system in which the coordinates are given.

Specified by:
getCoordinateReferenceSystem in interface Envelope
Returns:
The coordinate reference system, or null.

setCoordinateReferenceSystem

public void setCoordinateReferenceSystem(CoordinateReferenceSystem crs)
                                  throws MismatchedDimensionException
Sets the coordinate reference system in which the coordinate are given. This method do 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 normalize(boolean).

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

normalize

public boolean normalize(boolean crsDomain)
Restricts this envelope to the CS or CRS domain of validity. This method performs two steps:
  1. First, it ensures that the envelope is contained in the coordinate system domain. Out of range ordinates are validated in a way that depends on the range meaning:

    • If EXACT (typically latitudes ordinates), values greater than the maximum value are replaced by the maximum, and values smaller than the minimum value are replaced by the minimum.
    • If WRAPAROUND (typically longitudes ordinates), a multiple of the range (e.g. 360° for longitudes) is added or subtracted. If a value stay out of range after this correction, then the ordinates are set to the full [ minimum ... maximum] range.
      Example: [185° ... 190°] of longitude is equivalent to [-175° ... -170°]. But [175° ... 185°] would be equivalent to [175° ... -175°], which is likely to mislead most users of Envelope since the lower bounds is numerically greater than the upper bounds. Reordering as [-175° ... 175°] would interchange the meaning of what is "inside" and "outside" the envelope. So this implementation conservatively expands the range to [-180° ... 180°] in order to ensure that the validated envelope fully contains the original envelope.

  2. Second and only if crsDomain is true, the envelope normalized in the previous step is intersected with the CRS domain of validity, if any.

Parameters:
crsDomain - true if the envelope should be restricted to the CRS domain in addition of the CS domain.
Returns:
true if this envelope has been modified, or false if no change was done.
Since:
2.5

getDimension

public final int getDimension()
Returns the number of dimensions.

Specified by:
getDimension in interface Envelope
Returns:
The dimensionality of this envelope.

getLowerCorner

public DirectPosition getLowerCorner()
A coordinate position consisting of all the minimal ordinates for each dimension for all points within the Envelope.

Specified by:
getLowerCorner in interface Envelope
Overrides:
getLowerCorner in class AbstractEnvelope
Returns:
The lower corner.

getUpperCorner

public DirectPosition getUpperCorner()
A coordinate position consisting of all the maximal ordinates for each dimension for all points within the Envelope.

Specified by:
getUpperCorner in interface Envelope
Overrides:
getUpperCorner in class AbstractEnvelope
Returns:
The upper corner.

getMedian

public DirectPosition getMedian()
A coordinate position consisting of all the middle ordinates for each dimension for all points within the Envelope.

Returns:
The median coordinates.
Since:
2.5

getMinimum

public final double getMinimum(int dimension)
                        throws IndexOutOfBoundsException
Returns the minimal ordinate along the specified dimension.

Specified by:
getMinimum in interface Envelope
Parameters:
dimension - The dimension to query.
Returns:
The minimal ordinate value along the given dimension.
Throws:
IndexOutOfBoundsException - If the given index is out of bounds.
See Also:
RectangularShape.getMinX(), RectangularShape.getMinY()

getMaximum

public final double getMaximum(int dimension)
                        throws IndexOutOfBoundsException
Returns the maximal ordinate along the specified dimension.

Specified by:
getMaximum in interface Envelope
Parameters:
dimension - The dimension to query.
Returns:
The maximal ordinate value along the given dimension.
Throws:
IndexOutOfBoundsException - If the given index is out of bounds.
See Also:
RectangularShape.getMaxX(), RectangularShape.getMaxY()

getMedian

public final double getMedian(int dimension)
                       throws IndexOutOfBoundsException
Returns the median ordinate along the specified dimension. The result should be equals (minus rounding error) to (getMaximum(dimension) - getMinimum(dimension)) / 2.

Specified by:
getMedian in interface Envelope
Parameters:
dimension - The dimension to query.
Returns:
The mid ordinate value along the given dimension.
Throws:
IndexOutOfBoundsException - If the given index is out of bounds.
See Also:
RectangularShape.getCenterX(), RectangularShape.getCenterY()

getSpan

public final double getSpan(int dimension)
                     throws IndexOutOfBoundsException
Returns the envelope span (typically width or height) along the specified dimension. The result should be equals (minus rounding error) to getMaximum(dimension) - getMinimum(dimension).

Specified by:
getSpan in interface Envelope
Parameters:
dimension - The dimension to query.
Returns:
The difference along maximal and minimal ordinates in the given dimension.
Throws:
IndexOutOfBoundsException - If the given index is out of bounds.
See Also:
RectangularShape.getWidth(), RectangularShape.getHeight()

getSpan

public double getSpan(int dimension,
                      Unit<?> unit)
               throws IndexOutOfBoundsException,
                      ConversionException
Returns the envelope span along the specified dimension, in terms of the given units.

Parameters:
dimension - The dimension to query.
unit - The unit for the return value.
Returns:
The span in terms of the given unit.
Throws:
IndexOutOfBoundsException - If the given index is out of bounds.
ConversionException - if the length can't be converted to the specified units.
Since:
2.5

setRange

public void setRange(int dimension,
                     double minimum,
                     double maximum)
              throws IndexOutOfBoundsException
Sets the envelope's 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: (xmin, ymin, zmin, xmax, ymax, zmax)

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

setEnvelope

public void setEnvelope(GeneralEnvelope envelope)
                 throws MismatchedDimensionException
Sets this envelope to the same coordinate values than the specified envelope.

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

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

isNull

public boolean isNull()
Returns false if at least one ordinate value is not NaN. The isNull() check is a little bit different than 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:

Returns:
true if this envelope has NaN values.
Since:
2.2

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 length is greater than 0 along all dimensions. Note that a non-empty envelope is always non- null, but the converse is not always true.

Returns:
true if this envelope is empty.

add

public void add(DirectPosition position)
         throws MismatchedDimensionException
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(org.opengis.geometry.DirectPosition) with the added point as an argument will return true, except if one of the point's ordinates was Double.NaN (in which case the corresponding ordinate have been ignored).

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

Parameters:
position - The point to add.
Throws:
MismatchedDimensionException - if the specified point doesn't have the expected dimension.

add

public void add(Envelope envelope)
         throws MismatchedDimensionException
Adds an envelope object to this envelope. The resulting envelope is the union of the two Envelope objects.

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

Parameters:
envelope - the Envelope to add to this envelope.
Throws:
MismatchedDimensionException - if the specified envelope doesn't have the expected dimension.

contains

public boolean contains(DirectPosition position)
                 throws MismatchedDimensionException
Tests if a specified coordinate is inside the boundary of this envelope.

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

Parameters:
position - The point to text.
Returns:
true if the specified coordinates are inside the boundary of this envelope; false otherwise.
Throws:
MismatchedDimensionException - if the specified point doesn't have the expected dimension.

contains

public boolean contains(Envelope envelope,
                        boolean edgesInclusive)
                 throws MismatchedDimensionException
Returns true if this envelope completly encloses the specified envelope. If one or more edges from the specified envelope coincide with an edge from this envelope, then this method returns true only if edgesInclusive is true.

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

Parameters:
envelope - The envelope to test for inclusion.
edgesInclusive - true if this envelope edges are inclusive.
Returns:
true if this envelope completly encloses the specified one.
Throws:
MismatchedDimensionException - if the specified envelope doesn't have the expected dimension.
Since:
2.2
See Also:
intersects(Envelope, boolean), #equals(Envelope, double)

intersects

public boolean intersects(Envelope envelope,
                          boolean edgesInclusive)
                   throws MismatchedDimensionException
Returns true if this envelope intersects the specified envelope. If one or more edges from the specified envelope coincide with an edge from this envelope, then this method returns true only if edgesInclusive is true.

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

Parameters:
envelope - The envelope to test for intersection.
edgesInclusive - true if this envelope edges are inclusive.
Returns:
true if this envelope intersects the specified one.
Throws:
MismatchedDimensionException - if the specified envelope doesn't have the expected dimension.
Since:
2.2
See Also:
contains(Envelope, boolean), #equals(Envelope, double)

intersect

public void intersect(Envelope envelope)
               throws MismatchedDimensionException
Sets this envelope to the intersection if this envelope with the specified one.

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

Parameters:
envelope - the Envelope to intersect to this envelope.
Throws:
MismatchedDimensionException - if the specified envelope doesn't have the expected dimension.

getSubEnvelope

public GeneralEnvelope getSubEnvelope(int lower,
                                      int upper)
                               throws IndexOutOfBoundsException
Returns a new envelope that encompass only some dimensions of this envelope. This method copy this envelope's ordinates into a new envelope, beginning at dimension lower and extending to dimension upper-1. Thus the dimension of the subenvelope is upper-lower.

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

getReducedEnvelope

public GeneralEnvelope getReducedEnvelope(int lower,
                                          int upper)
                                   throws IndexOutOfBoundsException
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 subenvelope.
Throws:
IndexOutOfBoundsException - if an index is out of bounds.

toRectangle2D

public Rectangle2D toRectangle2D()
                          throws IllegalStateException
Returns a Rectangle2D with the same bounds as this Envelope. This is a convenience method for interoperability with Java2D.

Returns:
This envelope as a twp-dimensional rectangle.
Throws:
IllegalStateException - if this envelope is not two-dimensional.

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 equals to this envelope.

equals

public boolean equals(Envelope envelope,
                      double eps,
                      boolean epsIsRelative)
Compares to the specified envelope for equality up to the specified tolerance value. The tolerance value eps can be either relative to the envelope length along each dimension or can be an absolute value (as for example some ground resolution of a grid coverage).

If relativeToLength is set to true, the actual tolerance value for a given dimension i is eps×length where length is the maximum of this envelope length and the specified envelope length along dimension i.

If relativeToLength is set to false, the actual tolerance value for a given dimension i is eps.

Relative tolerance value (as opposed to absolute tolerance value) help to workaround the fact that tolerance value are CRS dependent. For example the tolerance value need to be smaller for geographic CRS than for UTM projections, because the former typically has a range of -180 to 180° while the later can have a range of thousands of meters.

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

Parameters:
envelope - The envelope to compare with.
eps - The tolerance value to use for numerical comparaisons.
epsIsRelative - true if the tolerance value should be relative to axis length, or false if it is an absolute value.
Returns:
true if the given object is equals to this envelope up to the given tolerance value.
Since:
2.4
See Also:
contains(Envelope, boolean), intersects(Envelope, boolean)

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


Copyright © 1996-2014 Geotools. All Rights Reserved.